Class BaseToolAbstract

constructor

• new BaseTool(config): BaseTool

• Constructor for BaseTool

  Parameters

  • config: ToolConfig

  Returns BaseTool

name

description

isLongRunning

shouldRetryOnFailure

maxRetryAttempts

baseRetryDelay

maxRetryDelay

getDeclaration

• getDeclaration(): FunctionDeclaration

• Gets the OpenAPI specification of this tool in the form of a FunctionDeclaration

  NOTE:

  • Required if subclass uses the default implementation of processLlmRequest to add function declaration to LLM request.
  • Otherwise, can return null, e.g. for a built-in GoogleSearch tool.

  Returns FunctionDeclaration

  The FunctionDeclaration of this tool, or null if it doesn't need to be added to LlmRequest.config.

validateArguments

• validateArguments(args): boolean

• Validates the arguments against the schema in the function declaration

  Parameters

  • args: Record<string, any>

    Arguments to validate

  Returns boolean

  True if arguments are valid

runAsync

• runAsync(_args, _context): Promise<any>

• Runs the tool with the given arguments and context

  NOTE:

  • Required if this tool needs to run at the client side.
  • Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool.

  Parameters

  • _args: Record<string, any>
  • _context: ToolContext

  Returns Promise<any>

  The result of running the tool

processLlmRequest

• processLlmRequest(_toolContext, llmRequest): Promise<void>

• Processes the outgoing LLM request for this tool.

  Use cases:

  • Most common use case is adding this tool to the LLM request.
  • Some tools may just preprocess the LLM request before it's sent out.

  Parameters

  • _toolContext: ToolContext
  • llmRequest: LlmRequest

    The outgoing LLM request, mutable by this method

  Returns Promise<void>

safeExecute

• safeExecute(args, context): Promise<any>

• Executes the tool with error handling and retries

  Parameters

  • args: Record<string, any>

    Arguments for the tool
  • context: ToolContext

    Tool execution context

  Returns Promise<any>

  Result of the tool execution or error information