Skip to main content

Interface: MCPTransport

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

Transport interface for MCP (Model Context Protocol) communication. Maps to the Transport interface in the MCP spec.

Properties​

onclose?​

optional onclose?: () => void

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

Event handler for transport closure

Returns​

void

onerror?​

optional onerror?: (error) => void

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

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.10+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:246

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; }; }; } | { 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.10+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:250

The protocol version negotiated during initialization.

Methods​

close()​

close(): Promise<void>

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

Clean up and close the transport

Returns​

Promise<void>

send()​

send(message): Promise<void>

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

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; }; }; } | { error: { code: number; data?: unknown; message: string; }; id: string | number; jsonrpc: "2.0"; }

The JSON-RPC message to send

Returns​

Promise<void>

setProtocolVersion()?​

optional setProtocolVersion(version): void

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

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.10+68a1e3a0c4588df3/node_modules/@ai-sdk/mcp/dist/index.d.ts:225

Initialize and start the transport

Returns​

Promise<void>