Class RemoteAgent

Executes a hosted MCP agent through the mcp-use remote API.

Index

Constructors

Methods

close run stream

Constructors

constructor

new RemoteAgent(options: RemoteAgentOptions): RemoteAgent
Parameters
- options: RemoteAgentOptions
  Hosted agent identifier and API connection settings.
Returns RemoteAgent

Throws
Error if no API key is supplied or available from MCP_USE_API_KEY.
- Defined in agents/remote.ts:73

Methods

close

close(): Promise<void>
Releases local remote-agent state.

Returns Promise<void>
- Defined in agents/remote.ts:453

run

run(options: RunOptions): Promise<string>
Runs the remote agent and returns its final text.
Parameters
- options: RunOptions
  Input and per-run execution settings.
Returns Promise<string>
Final agent text.
- Defined in agents/remote.ts:209
run<T>(options: RunOptions<T>): Promise<T>
Runs the remote agent and parses its result with options.schema.
Type Parameters
- T
Parameters
- options: RunOptions<T>
  Input, schema, and per-run execution settings.
Returns Promise<T>
The schema-validated result.
- Defined in agents/remote.ts:217
run<T = string>(
    query: string,
    maxSteps?: number,
    manageConnector?: boolean,
    externalHistory?: BaseMessage[],
    outputSchema?: ZodType<T, unknown, $ZodTypeInternals<T, unknown>>,
): Promise<T>
Runs the remote agent and returns a promise for the final result.
Type Parameters
- T = string
Parameters
- query: string
- OptionalmaxSteps: number
- OptionalmanageConnector: boolean
- OptionalexternalHistory: BaseMessage[]
- OptionaloutputSchema: ZodType<T, unknown, $ZodTypeInternals<T, unknown>>
Returns Promise<T>

Deprecated
Use the options object instead: run({ prompt, maxSteps, ... }).
- Defined in agents/remote.ts:223

stream

stream(options: RunOptions): AsyncGenerator<any, string, void>
Runs the remote agent through an async-generator interface.

The current remote API does not emit intermediate values. Read the generator's return value for the final result.
Parameters
- options: RunOptions
  Input and per-run execution settings.
Returns AsyncGenerator<any, string, void>
An async generator whose return value is the final text.
- Defined in agents/remote.ts:408
stream<T>(options: RunOptions<T>): AsyncGenerator<any, T, void>
Runs structured remote execution through an async-generator interface.
Type Parameters
- T
Parameters
- options: RunOptions<T>
  Input, schema, and per-run execution settings.
Returns AsyncGenerator<any, T, void>
An async generator whose return value is schema validated.
- Defined in agents/remote.ts:416
stream<T = string>(
    query: string,
    maxSteps?: number,
    manageConnector?: boolean,
    externalHistory?: BaseMessage[],
    outputSchema?: ZodType<T, unknown, $ZodTypeInternals<T, unknown>>,
): AsyncGenerator<any, T, void>
Streams the remote agent execution.
Type Parameters
- T = string
Parameters
- query: string
- OptionalmaxSteps: number
- OptionalmanageConnector: boolean
- OptionalexternalHistory: BaseMessage[]
- OptionaloutputSchema: ZodType<T, unknown, $ZodTypeInternals<T, unknown>>
Returns AsyncGenerator<any, T, void>

Deprecated
Use the options object instead: stream({ prompt, maxSteps, ... }).
- Defined in agents/remote.ts:422