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

    Class BaseToolsetAbstract

    Base class for toolset.

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

    Hierarchy (View Summary)

    Constructors

    Properties

    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 tools that should be exposed to LLM.

      Parameters

      • Optionalcontext: ReadonlyContext

        Context used to filter tools available to the agent. If not defined, all tools in the toolset are returned.

      Returns Promise<BaseTool[]>

      A Promise that resolves to the list of tools.

    • Returns whether the tool should be exposed to LLM.

      Parameters

      • tool: BaseTool

        The tool to check.

      • context: ReadonlyContext

        Context used to filter tools available to the agent.

      Returns boolean

      Whether the tool should be exposed to LLM.

    • 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: ToolContext

        The context of the tool.

      • llmRequest: LlmRequest

        The outgoing LLM request, mutable this method.

      Returns Promise<void>