Member Junction
    Preparing search index...

    Interface AgentToolDefinition<P>

    One agent-local tool.

    interface AgentToolDefinition<P = object> {
        Description: string;
        InputSchema: Record<string, unknown>;
        Name: string;
        Execute(
            args: Record<string, unknown>,
            context: AgentToolContext<P>,
        ): Promise<AgentToolResult<P>>;
    }

    Type Parameters

    • P = object
    Index

    Properties

    Description: string

    "Call this when…" — what the tool does and when to use it. At most 1024 characters.

    InputSchema: Record<string, unknown>

    JSON Schema for the arguments, in the cross-provider subset.

    Name: string

    The tool name the model calls: lowercase letters, digits and underscores, at most 64 characters. Must not be a control-tool name or start with delegate_to_.

    Methods