ADK for TypeScript: API Reference
    Preparing search index...

    Type Alias ToolOptions<TParameters>

    The configuration options for creating a function-based tool. The name, description and parameters fields are used to generate the tool definition that is passed to the LLM prompt.

    Note: Unlike Python's ADK, JSDoc on the execute function is ignored for tool definition generation.

    type ToolOptions<TParameters extends ToolInputParameters> = {
        description: string;
        execute: ToolExecuteFunction<TParameters>;
        isLongRunning?: boolean;
        name?: string;
        parameters?: TParameters;
    }

    Type Parameters

    Properties

    description: string
    execute: ToolExecuteFunction<TParameters>
    isLongRunning?: boolean
    name?: string
    parameters?: TParameters
    Properties