Class Agent

constructor

• new Agent(config?: AgentConfig): Agent

  Creates an instance of the Agent.

  Parameters

  • Optionalconfig: AgentConfig

    The configuration for the agent.

  Returns Agent

Readonlymessages

Readonlystate

ReadonlyconversationManager

Readonlyhooks

model

OptionalsystemPrompt

tools

• get tools(): Tool[]

  The tools this agent can use.

  Returns Tool[]

toolRegistry

• get toolRegistry(): ToolRegistry

  The tool registry for managing the agent's tools.

  Returns ToolRegistry

initialize

• initialize(): Promise<void>

  Returns Promise<void>

invoke

• invoke(args: InvokeArgs): Promise<AgentResult>

  Invokes the agent and returns the final result.

  This is a convenience method that consumes the stream() method and returns only the final AgentResult. Use stream() if you need access to intermediate streaming events.

  Parameters

  • args: InvokeArgs

    Arguments for invoking the agent

  Returns Promise<AgentResult>

  Promise that resolves to the final AgentResult

  Example

  const agent = new Agent({ model, tools })
  const result = await agent.invoke('What is 2 + 2?')
  console.log(result.lastMessage) // Agent's response
  Copy

stream

• stream(
      args: InvokeArgs,
  ): AsyncGenerator<AgentStreamEvent, AgentResult, undefined>

  Streams the agent execution, yielding events and returning the final result.

  The agent loop manages the conversation flow by:

  1. Streaming model responses and yielding all events
  2. Executing tools when the model requests them
  3. Continuing the loop until the model completes without tool use

  Use this method when you need access to intermediate streaming events. For simple request/response without streaming, use invoke() instead.

  An explicit goal of this method is to always leave the message array in a way that the agent can be reinvoked with a user prompt after this method completes. To that end assistant messages containing tool uses are only added after tool execution succeeds with valid toolResponses

  Parameters

  • args: InvokeArgs

    Arguments for invoking the agent

  Returns AsyncGenerator<AgentStreamEvent, AgentResult, undefined>

  Async generator that yields AgentStreamEvent objects and returns AgentResult

  Example

  const agent = new Agent({ model, tools })
  
  for await (const event of agent.stream('Hello')) {
    console.log('Event:', event.type)
  }
  // Messages array is mutated in place and contains the full conversation
  Copy