AxMCPRecordingTransport Generated TypeScript API reference. typescript api api/reference build/apidocs/Class.AxMCPRecordingTransport.md class AxMCPRecordingTransport

AxMCPRecordingTransport

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L30

Implements

Constructors

Constructor

TypeScript
new AxMCPRecordingTransport(inner: AxMCPTransport): AxMCPRecordingTransport;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L40

Parameters

ParameterType
innerAxMCPTransport

Returns

AxMCPRecordingTransport

Properties

PropertyModifierTypeDescription
evaluationModereadonly"record"Indicates whether optimizer/evaluation use can cause live side effects.

Methods

close()

TypeScript
close(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L149

Releases transport resources. Implementations should be idempotent.

Returns

Promise<void>

Implementation of

AxMCPTransport.close


connect()

TypeScript
connect(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L124

Connects to the transport if needed This method is optional and only required for transports that need connection setup

Returns

Promise<void>

Implementation of

AxMCPTransport.connect


getRecording()

TypeScript
getRecording(): readonly AxMCPTransportRecordingEntry[];

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L51

Returns

readonly AxMCPTransportRecordingEntry[]


send()

TypeScript
send(message: Readonly<AxMCPJSONRPCRequest<unknown>>, options?: Readonly<AxMCPRequestOptions>): Promise<AxMCPJSONRPCResponse<unknown>>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L55

Sends a JSON-RPC request or notification and returns the response

Parameters

ParameterTypeDescription
messageReadonly<AxMCPJSONRPCRequest<unknown>>The JSON-RPC request or notification to send
options?Readonly<AxMCPRequestOptions>-

Returns

Promise<AxMCPJSONRPCResponse<unknown>>

A Promise that resolves to the JSON-RPC response

Implementation of

AxMCPTransport.send


sendBatch()

TypeScript
sendBatch(messages: readonly Readonly<AxMCPJSONRPCRequest<unknown>>[], options?: Readonly<AxMCPRequestOptions>): Promise<readonly AxMCPJSONRPCResponse<unknown>[]>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L68

Sends one version-gated JSON-RPC batch on transports that support it.

Parameters

ParameterType
messagesreadonly Readonly<AxMCPJSONRPCRequest<unknown>>[]
options?Readonly<AxMCPRequestOptions>

Returns

Promise<readonly AxMCPJSONRPCResponse<unknown>[]>

Implementation of

AxMCPTransport.sendBatch


sendNotification()

TypeScript
sendNotification(message: Readonly<AxMCPJSONRPCNotification>): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L86

Sends a JSON-RPC notification

Parameters

ParameterTypeDescription
messageReadonly<AxMCPJSONRPCNotification>The JSON-RPC notification to send

Returns

Promise<void>

Implementation of

AxMCPTransport.sendNotification


sendResponse()

TypeScript
sendResponse(message: Readonly<AxMCPJSONRPCResponse>): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L96

Sends a JSON-RPC response for a server-initiated request. Transports that cannot receive server requests do not need to implement it.

Parameters

ParameterType
messageReadonly<AxMCPJSONRPCResponse>

Returns

Promise<void>

Implementation of

AxMCPTransport.sendResponse


setLifecycleHandler()

TypeScript
setLifecycleHandler(handler: (state: "reconnected") => void | Promise<void>): void;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L110

Registers transport lifecycle events that require client-level recovery.

Parameters

ParameterType
handler(state: "reconnected") => void | Promise<void>

Returns

void

Implementation of

AxMCPTransport.setLifecycleHandler


setMessageHandler()

TypeScript
setMessageHandler(handler: (message: Readonly<AxMCPJSONRPCMessage>) => void | Promise<void>): void;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L104

Registers a handler for server-initiated JSON-RPC requests and notifications that arrive outside a direct client request response.

Parameters

ParameterType
handler(message: Readonly<AxMCPJSONRPCMessage>) => void | Promise<void>

Returns

void

Implementation of

AxMCPTransport.setMessageHandler


setProtocolVersion()

TypeScript
setProtocolVersion(protocolVersion: string): void;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L116

Stores the negotiated MCP protocol version for transports that must emit it on later frames or HTTP requests.

Parameters

ParameterType
protocolVersionstring

Returns

void

Implementation of

AxMCPTransport.setProtocolVersion


startListening()

TypeScript
startListening(options?: Readonly<AxMCPListeningOptions>): 
  | AxMCPListeningHandle
| Promise<AxMCPListeningHandle>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L128

Starts a nonblocking server-message listener when the transport needs one.

Parameters

ParameterType
options?Readonly<AxMCPListeningOptions>

Returns

| AxMCPListeningHandle | Promise<AxMCPListeningHandle>

Implementation of

AxMCPTransport.startListening


takeRequestMetadata()

TypeScript
takeRequestMetadata(id: string | number): 
  | undefined
  | Readonly<{
  retryCount?: number;
}>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L120

One-shot metadata for the most recently completed request ID.

Parameters

ParameterType
idstring | number

Returns

| undefined | Readonly<{ retryCount?: number; }>

Implementation of

AxMCPTransport.takeRequestMetadata


terminateSession()

TypeScript
terminateSession(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/transports/recordingTransport.ts#L145

Terminates a negotiated transport session when supported.

Returns

Promise<void>

Implementation of

AxMCPTransport.terminateSession

Docs