Skip to main content

Interface: MCPTransport

Defined in: node_modules/.bun/@ai-sdk+mcp@2.0.45+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:263

Properties​

onclose?​

optional onclose?: () => void

Defined in: node_modules/.bun/@ai-sdk+mcp@2.0.45+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:294

Event handler for transport closure

Returns​

void

onerror?​

optional onerror?: (error) => void

Defined in: node_modules/.bun/@ai-sdk+mcp@2.0.45+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:298

Event handler for transport errors

Parameters​

error​

Error

Returns​

void

onmessage?​

optional onmessage?: (message) => void

Defined in: node_modules/.bun/@ai-sdk+mcp@2.0.45+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:302

Event handler for received messages

Parameters​

message​

{ id: string | number; jsonrpc: "2.0"; method: string; params?: {[key: string]: unknown; _meta?: {[key: string]: unknown; }; }; } | { jsonrpc: "2.0"; method: string; params?: {[key: string]: unknown; _meta?: {[key: string]: unknown; }; }; } | { id: string | number; jsonrpc: "2.0"; result: {[key: string]: unknown; _meta?: {[key: string]: unknown; }; resultType?: string; }; } | { error: { code: number; data?: unknown; message: string; }; id?: string | number; jsonrpc: "2.0"; }

Returns​

void

protocolVersion?​

optional protocolVersion?: string

Defined in: node_modules/.bun/@ai-sdk+mcp@2.0.45+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:306

The protocol version negotiated during initialization.

supportsMcpToolParameterHeaders?​

optional supportsMcpToolParameterHeaders?: boolean

Defined in: node_modules/.bun/@ai-sdk+mcp@2.0.45+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:275

Whether this transport mirrors x-mcp-header tool parameters into request headers.

supportsProtocolVersionDiscovery?​

optional supportsProtocolVersionDiscovery?: boolean

Defined in: node_modules/.bun/@ai-sdk+mcp@2.0.45+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:270

Whether this transport can probe for stateless MCP protocol versions.

Custom transports default to the legacy initialization flow unless they explicitly opt in.

Methods​

close()​

close(options?): Promise<void>

Defined in: node_modules/.bun/@ai-sdk+mcp@2.0.45+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:290

Clean up and close the transport

Parameters​

options?​

MCPTransportCloseOptions

Optional cancellation options for transport cleanup

Returns​

Promise<void>

send()​

send(message, options?): Promise<void>

Defined in: node_modules/.bun/@ai-sdk+mcp@2.0.45+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:285

Send a JSON-RPC message through the transport

Parameters​

message​

{ id: string | number; jsonrpc: "2.0"; method: string; params?: {[key: string]: unknown; _meta?: {[key: string]: unknown; }; }; } | { jsonrpc: "2.0"; method: string; params?: {[key: string]: unknown; _meta?: {[key: string]: unknown; }; }; } | { id: string | number; jsonrpc: "2.0"; result: {[key: string]: unknown; _meta?: {[key: string]: unknown; }; resultType?: string; }; } | { error: { code: number; data?: unknown; message: string; }; id?: string | number; jsonrpc: "2.0"; }

The JSON-RPC message to send

options?​

MCPTransportSendOptions

Optional request-scoped cancellation options

Returns​

Promise<void>

setProtocolVersion()?​

optional setProtocolVersion(version): void

Defined in: node_modules/.bun/@ai-sdk+mcp@2.0.45+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:310

Set the protocol version negotiated during initialization.

Parameters​

version​

string

Returns​

void

start()​

start(): Promise<void>

Defined in: node_modules/.bun/@ai-sdk+mcp@2.0.45+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:279

Initialize and start the transport

Returns​

Promise<void>