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

    Class OpenAPIToolset

    Base class for toolset.

    A toolset is a collection of tools that can be used by an agent.

    Hierarchy (View Summary)

    Constructors

    • Parameters

      • options: {
            authCredential?: AuthCredential;
            authScheme?: SecuritySchemeObject;
            credentialKey?: string;
            headerProvider?: (context: ReadonlyContext) => Record<string, string>;
            prefix?: string;
            preservePropertyNames?: boolean;
            specDict?: Document<{}>;
            specStr?: string;
            specType?: "json" | "yaml";
            toolFilter?: string[] | ToolPredicate;
        } = {}

      Returns OpenAPIToolset

    Properties

    "[BASE_TOOLSET_SIGNATURE_SYMBOL]": true
    prefix?: string
    toolFilter: string[] | ToolPredicate

    Methods

    • Closes the toolset.

      NOTE: This method is invoked, for example, at the end of an agent server's lifecycle or when the toolset is no longer needed. Implementations should ensure that any open connections, files, or other managed resources are properly released to prevent leaks.

      Returns Promise<void>

      A Promise that resolves when the toolset is closed.

    • Returns the parsed tool with the given name, or undefined when the spec produced no such tool.

      The lookup is over every tool parsed from the spec and does not apply toolFilter, which selects what an agent exposes to the model rather than what the toolset holds. When the toolset was constructed with prefix, pass the prefixed name.

      Parameters

      • toolName: string

      Returns RestApiTool | undefined

    • Processes the outgoing LLM request for this toolset. This method will be called before each tool processes the llm request.

      Use cases:

      • Instead of let each tool process the llm request, we can let the toolset process the llm request. e.g. ComputerUseToolset can add computer use tool to the llm request.

      Parameters

      • _toolContext: Context

        The context of the tool.

      • _llmRequest: LlmRequest

        The outgoing LLM request, mutable this method.

      Returns Promise<void>

    Constructors
    Properties
    Methods