Class Protocol<SendRequestT, SendNotificationT, SendResultT>`Abstract`

Implements MCP protocol framing on top of a pluggable transport, including features like request/response linking, notifications, and progress.

Type Parameters

SendRequestT extends Request
SendNotificationT extends Notification
SendResultT extends Result

Hierarchy (View Summary)

Protocol
- Client
- Server

Index

Constructors

constructor

new Protocol<
    SendRequestT extends
        {
            method: string;
            params?: {
                _meta?: { progressToken?: string
                | number; [key: string]: unknown };
                [key: string]: unknown;
            };
        },
    SendNotificationT extends
        {
            method: string;
            params?: { _meta?: { [key: string]: unknown }; [key: string]: unknown };
        },
    SendResultT extends
        { _meta?: { [key: string]: unknown }; [key: string]: unknown },
>(
    _options?: ProtocolOptions,
): Protocol<SendRequestT, SendNotificationT, SendResultT>
Type Parameters
- SendRequestT extends {
      method: string;
      params?: {
          _meta?: { progressToken?: string | number; [key: string]: unknown };
          [key: string]: unknown;
      };
  }
- SendNotificationT extends {
  method: string;
  params?: { _meta?: { [key: string]: unknown }; [key: string]: unknown };
  }
- SendResultT extends { _meta?: { [key: string]: unknown }; [key: string]: unknown }
Parameters
- Optional_options: ProtocolOptions
Returns Protocol<SendRequestT, SendNotificationT, SendResultT>
- Defined in src/shared/protocol.ts:227

Properties

`Optional`fallbackNotificationHandler

fallbackNotificationHandler?: (
    notification: {
        method: string;
        params?: { _meta?: { [key: string]: unknown }; [key: string]: unknown };
    },
) => Promise<void>

A handler to invoke for any notification types that do not have their own handler installed.

`Optional`fallbackRequestHandler

fallbackRequestHandler?: (
    request: {
        method: string;
        params?: {
            _meta?: { progressToken?: string | number; [key: string]: unknown };
            [key: string]: unknown;
        };
    },
) => Promise<SendResultT>

A handler to invoke for any request types that do not have their own handler installed.

`Optional`onclose

onclose?: () => void

Callback for when the connection is closed for any reason.

This is invoked when close() is called as well.

`Optional`onerror

onerror?: (error: Error) => void

Callback for when an error occurs.

Note that errors are not necessarily fatal; they are used for reporting any kind of exceptional condition out of band.

Accessors

transport

get transport(): Transport | undefined
Returns Transport | undefined
- Defined in src/shared/protocol.ts:498

Methods

assertCanSetRequestHandler

assertCanSetRequestHandler(method: string): void
Asserts that a request handler has not already been set for the given method, in preparation for a new one being automatically installed.
Parameters
- method: string
Returns void
- Defined in src/shared/protocol.ts:726

`Protected` `Abstract`assertCapabilityForMethod

assertCapabilityForMethod(method: SendRequestT["method"]): void
A method to check if a capability is supported by the remote side, for the given method to be called.

This should be implemented by subclasses.
Parameters
- method: SendRequestT["method"]
Returns void
- Defined in src/shared/protocol.ts:514

`Protected` `Abstract`assertNotificationCapability

assertNotificationCapability(method: SendNotificationT["method"]): void
A method to check if a notification is supported by the local side, for the given method to be sent.

This should be implemented by subclasses.
Parameters
- method: SendNotificationT["method"]
Returns void
- Defined in src/shared/protocol.ts:523

`Protected` `Abstract`assertRequestHandlerCapability

assertRequestHandlerCapability(method: string): void
A method to check if a request handler is supported by the local side, for the given method to be handled.

This should be implemented by subclasses.
Parameters
- method: string
Returns void
- Defined in src/shared/protocol.ts:532

close

close(): Promise<void>
Closes the connection.

Returns Promise<void>
- Defined in src/shared/protocol.ts:505

connect

connect(transport: Transport): Promise<void>
Attaches to the given transport, starts it, and starts listening for messages.

The Protocol object assumes ownership of the Transport, replacing any callbacks that have already been set, and expects that it is the only user of the Transport instance going forward.
Parameters
- transport: Transport
Returns Promise<void>
- Defined in src/shared/protocol.ts:295

notification

notification(
notification: SendNotificationT,
options?: NotificationOptions,
): Promise<void>
Emits a notification, which is a one-way message that does not expect a response.
Parameters
- notification: SendNotificationT
- Optionaloptions: NotificationOptions
Returns Promise<void>
- Defined in src/shared/protocol.ts:637

removeNotificationHandler

removeNotificationHandler(method: string): void
Removes the notification handler for the given method.
Parameters
- method: string
Returns void
- Defined in src/shared/protocol.ts:757

removeRequestHandler

removeRequestHandler(method: string): void
Removes the request handler for the given method.
Parameters
- method: string
Returns void
- Defined in src/shared/protocol.ts:719

request

request<T extends ZodType<object, ZodTypeDef, object>>(
    request: SendRequestT,
    resultSchema: T,
    options?: RequestOptions,
): Promise<TypeOf<T>>
Sends a request and wait for a response.

Do not use this method to emit notifications! Use notification() instead.
Type Parameters
- T extends ZodType<object, ZodTypeDef, object>
Parameters
- request: SendRequestT
- resultSchema: T
- Optionaloptions: RequestOptions
Returns Promise<TypeOf<T>>
- Defined in src/shared/protocol.ts:539

setNotificationHandler

setNotificationHandler<
    T extends
        ZodObject<
            { method: ZodLiteral<string> },
            UnknownKeysParam,
            ZodTypeAny,
            { method: string },
            { method: string },
        >,
>(
    notificationSchema: T,
    handler: (notification: TypeOf<T>) => void | Promise<void>,
): void
Registers a handler to invoke when this protocol object receives a notification with the given method.

Note that this will replace any previous notification handler for the same method.
Type Parameters
- T extends ZodObject<
      { method: ZodLiteral<string> },
      UnknownKeysParam,
      ZodTypeAny,
      { method: string },
      { method: string },
  >
Parameters
- notificationSchema: T
- handler: (notification: TypeOf<T>) => void | Promise<void>
Returns void
- Defined in src/shared/protocol.ts:739

setRequestHandler

setRequestHandler<
    T extends
        ZodObject<
            { method: ZodLiteral<string> },
            UnknownKeysParam,
            ZodTypeAny,
            { method: string },
            { method: string },
        >,
>(
    requestSchema: T,
    handler: (
        request: TypeOf<T>,
        extra: RequestHandlerExtra<SendRequestT, SendNotificationT>,
    ) => SendResultT | Promise<SendResultT>,
): void
Registers a handler to invoke when this protocol object receives a request with the given method.

Note that this will replace any previous request handler for the same method.
Type Parameters
- T extends ZodObject<
      { method: ZodLiteral<string> },
      UnknownKeysParam,
      ZodTypeAny,
      { method: string },
      { method: string },
  >
Parameters
- requestSchema: T
- handler: (
  request: TypeOf<T>,
  extra: RequestHandlerExtra<SendRequestT, SendNotificationT>,
  ) => SendResultT | Promise<SendResultT>
Returns void
- Defined in src/shared/protocol.ts:697

Class Protocol<SendRequestT, SendNotificationT, SendResultT>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Protocol<SendRequestT, SendNotificationT, SendResultT>

Properties

OptionalfallbackNotificationHandler

OptionalfallbackRequestHandler

Optionalonclose

Optionalonerror

Accessors

transport

Returns Transport | undefined

Methods

assertCanSetRequestHandler

Parameters

Returns void

Protected AbstractassertCapabilityForMethod

Parameters

Returns void

Protected AbstractassertNotificationCapability

Parameters

Returns void

Protected AbstractassertRequestHandlerCapability

Parameters

Returns void

close

Returns Promise<void>

connect

Parameters

Returns Promise<void>

notification

Parameters

Returns Promise<void>

removeNotificationHandler

Parameters

Returns void

removeRequestHandler

Parameters

Returns void

request

Type Parameters

Parameters

Returns Promise<TypeOf<T>>

setNotificationHandler

Type Parameters

Parameters

Returns void

setRequestHandler

Type Parameters

Parameters

Returns void

Settings

On This Page

Class Protocol<SendRequestT, SendNotificationT, SendResultT>`Abstract`

`Optional`fallbackNotificationHandler

`Optional`fallbackRequestHandler

`Optional`onclose

`Optional`onerror

`Protected` `Abstract`assertCapabilityForMethod

`Protected` `Abstract`assertNotificationCapability

`Protected` `Abstract`assertRequestHandlerCapability