@archastro/sdk
    Preparing search index...

    Interface BuiltinToolCatalogEntry

    A catalog entry describing a category of platform-provided (builtin) tools that can be enabled for an agent. Each entry groups one or more individual tools under a shared key, label, and configuration schema.

    interface BuiltinToolCatalogEntry {
        config_schema?: Record<string, unknown>;
        description?: string;
        instruction?: string;
        key: string;
        label?: string;
        multi_instance_mode?: string;
        providers?: string[];
        requires_integration?: boolean;
        server_tool_type?: string;
        tools?: BuiltinTool[];
    }
    Index

    Properties

    config_schema? description? instruction? key label? multi_instance_mode? providers? requires_integration? server_tool_type? tools?

    Properties

    config_schema?: Record<string, unknown>

    JSON Schema object describing the configuration options for this tool category. Clients should use this schema to render and validate configuration forms before submitting. null when no configuration is needed.

    description?: string

    Short prose description of what this tool category does. Suitable for display in setup UIs. null when no description has been defined.

    instruction?: string

    Additional guidance surfaced to the agent at runtime when this tool category is enabled. null when no custom instruction is set.

    key: string

    Unique slug identifying this tool category, e.g. "web_search" or "github".

    label?: string

    Human-readable display name for the tool category, e.g. "Web Search". null when no label has been assigned.

    multi_instance_mode?: string

    Controls whether multiple instances of this tool category may be enabled simultaneously. "namespaced" — multiple instances allowed; each must carry a name_prefix to distinguish them. "passthrough" — multiple instances allowed without a name_prefix; names are derived from the underlying source. null — single-instance only.

    providers?: string[]

    List of integration provider slugs that can back this tool category, e.g. ["github", "gitlab"]. Empty when the tool is provider-agnostic.

    requires_integration?: boolean

    Whether enabling this tool category requires the user to connect a third-party integration. true means at least one active integration of the appropriate type must exist before the tool can be used.

    server_tool_type?: string

    Internal type identifier used by the platform server when registering these tools. null for client-side-only tool categories.

    tools?: BuiltinTool[]

    Array of individual tool definitions included in this category. Each entry describes a single callable tool with its own name and description.

    Settings

    Member Visibility

    On This Page

    Properties