Skip to main content

Class: StatefulMCPServerProvider

openaiAgents.StatefulMCPServerProvider

Stateful MCP server provider. Maintains a persistent MCP connection per Workflow run via a dedicated in-process Worker on a per-run Task Queue.

Callers must handle ApplicationFailure with type "DedicatedWorkerFailure" if the dedicated Worker fails to start or misses a heartbeat.

Constructors

constructor

new StatefulMCPServerProvider(name, serverFactory, nativeConnection): StatefulMCPServerProvider

Parameters

NameTypeDescription
namestringThe internal name is ${name}-stateful to avoid colliding with stateless providers using the same base name.
serverFactory(factoryArgument?: unknown) => MCPServerMust return a fresh server instance per call (one per Workflow run).
nativeConnectionNativeConnectionNativeConnection used by the dedicated per-run Worker; typically the same one the main Worker uses.

Returns

StatefulMCPServerProvider

Accessors

name

get name(): string

Returns

string

Methods

_getActivities

_getActivities(): Record<string, (...args: any[]) => Promise<unknown>>

Returns

Record<string, (...args: any[]) => Promise<unknown>>