@archastro/sdk
    Preparing search index...

    Interface AgentTool

    A tool attached to an agent, defining a capability the agent can invoke during a conversation or task run.

    interface AgentTool {
        agent?: string;
        app?: string;
        async?: boolean;
        builtin_tool_config?: Record<string, unknown>;
        builtin_tool_key?: string;
        config?: string;
        created_at?: string;
        description?: string;
        handler_type?: string;
        id: string;
        instruction?: string;
        kind?: string;
        last_applied_template_config?: string;
        lookup_key?: string;
        metadata?: Record<string, unknown>;
        name?: string;
        name_prefix?: string;
        parameters?: Record<string, unknown>;
        parameters_config?: string;
        status?: string;
        updated_at?: string;
    }
    Index

    Properties

    agent? app? async? builtin_tool_config? builtin_tool_key? config? created_at? description? handler_type? id instruction? kind? last_applied_template_config? lookup_key? metadata? name? name_prefix? parameters? parameters_config? status? updated_at?

    Properties

    agent?: string

    ID of the agent this tool belongs to (agi_...).

    app?: string

    ID of the application that owns this tool (dap_...).

    async?: boolean

    true when the tool executes asynchronously and returns a task handle rather than an immediate result.

    builtin_tool_config?: Record<string, unknown>

    Provider-specific configuration for the built-in tool. Present only when kind is "builtin". Shape varies by builtin_tool_key.

    builtin_tool_key?: string

    Registry key identifying the built-in tool implementation. Present only when kind is "builtin".

    config?: string

    ID of the config record (cfg_...) containing this tool's full configuration. null for inline-only tools.

    created_at?: string

    When the tool was created (ISO 8601).

    description?: string

    Description of what the tool does, passed to the LLM as part of the tool definition. Resolved from the built-in registry for kind: "builtin" tools.

    handler_type?: string

    Execution handler type. One of "http", "script", or "builtin".

    id: string

    Tool ID (atl_...).

    instruction?: string

    Optional system-level instruction appended to the agent prompt when this tool is active.

    kind?: string

    Tool kind. One of "builtin", "custom", or "mcp".

    last_applied_template_config?: string

    ID of the AgentToolTemplate config (cfg_...) this tool was last provisioned or updated from. null for manually created tools.

    lookup_key?: string

    Stable, user-defined identifier for this tool within the agent. Unique per agent.

    metadata?: Record<string, unknown>

    Arbitrary key-value metadata attached to the tool. Not interpreted by the platform.

    name?: string

    Human-readable name of the tool as exposed to the LLM. Resolved from the built-in registry for kind: "builtin" tools.

    name_prefix?: string

    Per-instance namespace prepended to LLM-facing tool names for built-in tools that support multiple instances per agent. null when not applicable.

    parameters?: Record<string, unknown>

    JSON Schema object describing the tool's input parameters as presented to the LLM.

    parameters_config?: string

    ID of the config record (cfg_...) storing the tool's parameter schema. null when parameters are defined inline.

    status?: string

    Current status of the tool. One of "active" or "disabled".

    updated_at?: string

    When the tool was last modified (ISO 8601).

    Settings

    Member Visibility

    On This Page

    Properties