Class MCPAgent

Runs provider-neutral LLM tool loops against one or more MCP servers.

Index

Constructors

Methods

chat clearConversationHistory close getConversationHistory initialize run setSystemMessage stream streamEvents getPackageVersion

Constructors

constructor

new MCPAgent(options: MCPAgentOptions): MCPAgent
Creates an MCP agent.

Call initialize before the first local run unless autoInitialize is enabled. Setting agentId creates a remote agent.
Parameters
- options: MCPAgentOptions
  Model, MCP connection, and execution settings.
Returns MCPAgent

Throws
Error if local execution has no MCP servers, client, or connectors.
- Defined in agents/mcp_agent.ts:122

Methods

chat

chat(
options: { messages: ProviderMessage[]; signal?: AbortSignal },
): Promise<string>
Runs a single model completion without MCP tools.
Parameters
- options: { messages: ProviderMessage[]; signal?: AbortSignal }
  Provider-neutral messages and optional cancellation signal.
Returns Promise<string>
Final assistant text.
- Defined in agents/mcp_agent.ts:617

clearConversationHistory

clearConversationHistory(): void
Removes all stored user and assistant messages.

Returns void
- Defined in agents/mcp_agent.ts:395

close

close(): Promise<void>
Closes MCP sessions created by this agent and resets initialization state.

Existing clients supplied by the caller remain open.

Returns Promise<void>
- Defined in agents/mcp_agent.ts:635

getConversationHistory

getConversationHistory(): ProviderMessage[]
Returns ProviderMessage[]
A shallow copy of stored provider-neutral conversation history.
- Defined in agents/mcp_agent.ts:390

initialize

initialize(): Promise<void>
Resolves the model configuration, connects MCP servers, and loads tools.

Calling this method more than once has no effect until close.

Returns Promise<void>

Throws
Error if the model configuration is incomplete or no driver can be created.
- Defined in agents/mcp_agent.ts:224

run

run(options: RunOptions): Promise<string>
Runs the agent and resolves with the final assistant text.
Parameters
- options: RunOptions
  Input and per-run execution settings.
Returns Promise<string>
Final assistant text.
- Defined in agents/mcp_agent.ts:437
run<T>(options: RunOptions<T>): Promise<T>
Runs the agent and resolves with the final assistant text.
Type Parameters
- T
Parameters
- options: RunOptions<T>
  Input and per-run execution settings.
Returns Promise<T>
Final assistant text.
- Defined in agents/mcp_agent.ts:438
run(
    query: string,
    maxSteps?: number,
    manageConnector?: boolean,
    externalHistory?: unknown,
    outputSchema?: undefined,
    signal?: AbortSignal,
): Promise<string>
Parameters
- query: string
- OptionalmaxSteps: number
- OptionalmanageConnector: boolean
- OptionalexternalHistory: unknown
- OptionaloutputSchema: undefined
- Optionalsignal: AbortSignal
Returns Promise<string>

Deprecated
Use run({ prompt, maxSteps, ... }).
- Defined in agents/mcp_agent.ts:440
run<T>(
    query: string,
    maxSteps?: number,
    manageConnector?: boolean,
    externalHistory?: unknown,
    outputSchema?: ZodType<T, unknown, $ZodTypeInternals<T, unknown>>,
    signal?: AbortSignal,
): Promise<T>
Type Parameters
- T
Parameters
- query: string
- OptionalmaxSteps: number
- OptionalmanageConnector: boolean
- OptionalexternalHistory: unknown
- OptionaloutputSchema: ZodType<T, unknown, $ZodTypeInternals<T, unknown>>
- Optionalsignal: AbortSignal
Returns Promise<T>

Deprecated
Use run({ prompt, schema, maxSteps, ... }).
- Defined in agents/mcp_agent.ts:449

setSystemMessage

setSystemMessage(message: string): void
Replaces the system instruction used by subsequent runs.
Parameters
- message: string
  New system instruction.
Returns void
- Defined in agents/mcp_agent.ts:404

stream

stream(options: RunOptions): AsyncGenerator<AgentStep, string, void>
Runs the agent, yielding each completed tool step.

The generator's return value is the final assistant text.
Parameters
- options: RunOptions
  Input and per-run execution settings.
Returns AsyncGenerator<AgentStep, string, void>
An async generator of completed tool steps.
- Defined in agents/mcp_agent.ts:511
stream<T>(options: RunOptions<T>): AsyncGenerator<AgentStep, T, void>
Runs the agent, yielding each completed tool step.

The generator's return value is the final assistant text.
Type Parameters
- T
Parameters
- options: RunOptions<T>
  Input and per-run execution settings.
Returns AsyncGenerator<AgentStep, T, void>
An async generator of completed tool steps.
- Defined in agents/mcp_agent.ts:512
stream<T = string>(
    query: string,
    maxSteps?: number,
    manageConnector?: boolean,
    externalHistory?: unknown,
    outputSchema?: ZodType<T, unknown, $ZodTypeInternals<T, unknown>>,
    signal?: AbortSignal,
): AsyncGenerator<AgentStep, string | T, void>
Type Parameters
- T = string
Parameters
- query: string
- OptionalmaxSteps: number
- OptionalmanageConnector: boolean
- OptionalexternalHistory: unknown
- OptionaloutputSchema: ZodType<T, unknown, $ZodTypeInternals<T, unknown>>
- Optionalsignal: AbortSignal
Returns AsyncGenerator<AgentStep, string | T, void>

Deprecated
Use stream({ prompt, maxSteps, ... }).
- Defined in agents/mcp_agent.ts:514

streamEvents

streamEvents(options: RunOptions): AsyncGenerator<LlmStreamEvent, void, unknown>
Runs the agent and yields provider-neutral token, tool, usage, and lifecycle events.
Parameters
- options: RunOptions
  Input and per-run execution settings.
Returns AsyncGenerator<LlmStreamEvent, void, unknown>
An async generator of low-level stream events.

Throws
Error for remote agents, which do not support event streaming.
- Defined in agents/mcp_agent.ts:572
streamEvents<T>(
options: RunOptions<T>,
): AsyncGenerator<LlmStreamEvent, void, unknown>
Runs the agent and yields provider-neutral token, tool, usage, and lifecycle events.
Type Parameters
- T
Parameters
- options: RunOptions<T>
  Input and per-run execution settings.
Returns AsyncGenerator<LlmStreamEvent, void, unknown>
An async generator of low-level stream events.

Throws
Error for remote agents, which do not support event streaming.
- Defined in agents/mcp_agent.ts:575
streamEvents<T = string>(
    query: string,
    maxSteps?: number,
    manageConnector?: boolean,
    externalHistory?: unknown,
    outputSchema?: ZodType<T, unknown, $ZodTypeInternals<T, unknown>>,
    signal?: AbortSignal,
): AsyncGenerator<LlmStreamEvent, void, unknown>
Type Parameters
- T = string
Parameters
- query: string
- OptionalmaxSteps: number
- OptionalmanageConnector: boolean
- OptionalexternalHistory: unknown
- OptionaloutputSchema: ZodType<T, unknown, $ZodTypeInternals<T, unknown>>
- Optionalsignal: AbortSignal
Returns AsyncGenerator<LlmStreamEvent, void, unknown>

Deprecated
Use streamEvents({ prompt, maxSteps, ... }).
- Defined in agents/mcp_agent.ts:579

`Static`getPackageVersion

getPackageVersion(): string
Returns string
The installed @mcp-use/agent package version.
- Defined in agents/mcp_agent.ts:81

Class MCPAgent

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MCPAgent

Throws

Methods

chat

Parameters

Returns Promise<string>

clearConversationHistory

Returns void

close

Returns Promise<void>

getConversationHistory

Returns ProviderMessage[]

initialize

Returns Promise<void>

Throws

run

Parameters

Returns Promise<string>

Type Parameters

Parameters

Returns Promise<T>

Parameters

Returns Promise<string>

Deprecated

Type Parameters

Parameters

Returns Promise<T>

Deprecated

setSystemMessage

Parameters

Returns void

stream

Parameters

Returns AsyncGenerator<AgentStep, string, void>

Type Parameters

Parameters

Returns AsyncGenerator<AgentStep, T, void>

Type Parameters

Parameters

Returns AsyncGenerator<AgentStep, string | T, void>

Deprecated

streamEvents

Parameters

Returns AsyncGenerator<LlmStreamEvent, void, unknown>

Throws

Type Parameters

Parameters

Returns AsyncGenerator<LlmStreamEvent, void, unknown>

Throws

Type Parameters

Parameters

Returns AsyncGenerator<LlmStreamEvent, void, unknown>

Deprecated

StaticgetPackageVersion

Returns string

Settings

On This Page

`Static`getPackageVersion