Class Agent

constructor

• new Agent(options: AgentOptions<Provider<any, any, any>>): Agent

  Creates an instance of Agent.

  Parameters

  • options: AgentOptions<Provider<any, any, any>>

  Returns Agent

clients

name

provider

settings

toolMap

connectClients

• connectClients(): Promise<void>

  Returns Promise<void>

defaultSettings

• defaultSettings(): AgentSettings

  Returns AgentSettings

deleteTool

• deleteTool(name: string): void

  Removes a tool from the agent

  Parameters

  • name: string

  Returns void

findTool

• findTool(name: string): Promise<Tool>

  Returns a tool by name

  Parameters

  • name: string

  Returns Promise<Tool>

generateText

• generateText(
      params: GenerateTextParams,
  ): Promise<Result<undefined | GenerateTextResult<ToolSet, unknown>>>

  Call the Provider's language model to generate a text response from the supplied prompt or messages.

  Parameters

  • params: GenerateTextParams

  Returns Promise<Result<undefined | GenerateTextResult<ToolSet, unknown>>>

listClientTools

• listClientTools(): Promise<void>

  Returns Promise<void>

putTool

• putTool(tool: Tool): void

  Adds or replaces a tool in the agent's tools.

  Parameters

  • tool: Tool

  Returns void

streamText

• streamText(
      params: GenerateStreamParams,
  ): Promise<StreamTextResult<ToolSet, unknown>>

  Parameters

  • params: GenerateStreamParams

  Returns Promise<StreamTextResult<ToolSet, unknown>>

tools

• tools(extraTools?: Tool[]): Promise<Record<string, Tool>>

  This will compile all agent tool sources into a single map. It will use all class tools, all mcp client tools, and any extra tools passed in as an argument to the function.

  Parameters

  • extraTools: Tool[] = []

  Returns Promise<Record<string, Tool>>