Class Client

An MCP client on top of a pluggable transport.

The client will automatically begin the initialization flow with the server when connect is called.

Hierarchy

Protocol<ClientContext>
- Client

Constructors

constructor

new Client(
    _clientInfo: {
        description?: string;
        icons?: {
            mimeType?: string;
            sizes?: string[];
            src: string;
            theme?: "light" | "dark";
        }[];
        name: string;
        title?: string;
        version: string;
        websiteUrl?: string;
    },
    options?: ClientOptions,
): Client
Initializes this client with the given name and version information.
Parameters
- _clientInfo: {
      description?: string;
      icons?: {
          mimeType?: string;
          sizes?: string[];
          src: string;
          theme?: "light" | "dark";
      }[];
      name: string;
      title?: string;
      version: string;
      websiteUrl?: string;
  }
  - Optionaldescription?: string
    An optional human-readable description of what this implementation does.
    
    This can be used by clients or servers to provide context about their purpose and capabilities. For example, a server might describe the types of resources or tools it provides, while a client might describe its intended use case.
  - Optionalicons?: { mimeType?: string; sizes?: string[]; src: string; theme?: "light" | "dark" }[]
    Optional set of sized icons that the client can display in a user interface.
    
    Clients that support rendering icons MUST support at least the following MIME types:
    
    image/png - PNG images (safe, universal compatibility)
    
    image/jpeg (and image/jpg) - JPEG images (safe, universal compatibility)
    
    Clients that support rendering icons SHOULD also support:
    
    image/svg+xml - SVG images (scalable but requires security precautions)
    
    image/webp - WebP images (modern, efficient format)
  - name: string
    Intended for programmatic or logical use, but used as a display name in past specs or fallback
  - Optionaltitle?: string
    Intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology.
    
    If not provided, the name should be used for display (except for Tool, where annotations.title should be given precedence over using name, if present).
  - version: string
  - OptionalwebsiteUrl?: string
    An optional URL of the website for this implementation.
- Optionaloptions: ClientOptions
Returns Client
Overrides Protocol<ClientContext>.constructor
- Defined in packages/client/src/client/client.ts:222

Properties

`Protected`_supportedProtocolVersions

_supportedProtocolVersions: string[]

`Optional`fallbackNotificationHandler

fallbackNotificationHandler?: (
    notification: {
        method: string;
        params?: {
            _meta?: {
                "io.modelcontextprotocol/related-task"?: { taskId: string };
                progressToken?: string | number;
                [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: {
        id: string | number;
        jsonrpc: "2.0";
        method: string;
        params?: {
            _meta?: {
                "io.modelcontextprotocol/related-task"?: { taskId: string };
                progressToken?: string | number;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
    },
    ctx: BaseContext,
) => Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>

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

experimental

get experimental(): { tasks: ExperimentalClientTasks }
Experimental
Access experimental features.

WARNING: These APIs are experimental and may change without notice.

Returns { tasks: ExperimentalClientTasks }
- Defined in packages/client/src/client/client.ts:288

taskManager

get taskManager(): TaskManager
Access the TaskManager for task orchestration. Always available; returns a NullTaskManager when no task store is configured.

Returns TaskManager
Inherited from Protocol.taskManager
- Defined in packages/core/src/shared/protocol.ts:363

transport

get transport(): Transport | undefined
Returns Transport | undefined
Inherited from Protocol.transport
- Defined in packages/core/src/shared/protocol.ts:727

Methods

`Protected`_requestWithSchema

_requestWithSchema<T extends AnySchema>(
    request: {
        method: string;
        params?: {
            _meta?: {
                "io.modelcontextprotocol/related-task"?: { taskId: string };
                progressToken?: string | number;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
    },
    resultSchema: T,
    options?: RequestOptions,
): Promise<SchemaOutput<T>>
Sends a request and waits for a response, using the provided schema for validation.

This is the internal implementation used by SDK methods that need to specify a particular result schema (e.g., for compatibility or task-specific schemas).
Type Parameters
- T extends AnySchema
Parameters
- request: {
      method: string;
      params?: {
          _meta?: {
              "io.modelcontextprotocol/related-task"?: { taskId: string };
              progressToken?: string | number;
              [key: string]: unknown;
          };
          [key: string]: unknown;
      };
  }
- resultSchema: T
- Optionaloptions: RequestOptions
Returns Promise<SchemaOutput<T>>
Inherited from Protocol._requestWithSchema
- Defined in packages/core/src/shared/protocol.ts:795

assertCanSetRequestHandler

assertCanSetRequestHandler(method: RequestMethod): 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: RequestMethod
Returns void
Inherited from Protocol.assertCanSetRequestHandler
- Defined in packages/core/src/shared/protocol.ts:1031

`Protected`assertCapability

assertCapability(
    capability:
        | "tools"
        | "experimental"
        | "tasks"
        | "extensions"
        | "logging"
        | "completions"
        | "prompts"
        | "resources",
    method: string,
): void
Parameters
- capability:
      | "tools"
      | "experimental"
      | "tasks"
      | "extensions"
      | "logging"
      | "completions"
      | "prompts"
      | "resources"
- method: string
Returns void
- Defined in packages/client/src/client/client.ts:457

`Protected`assertCapabilityForMethod

assertCapabilityForMethod(method: RequestMethod): 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: RequestMethod
Returns void
Overrides Protocol.assertCapabilityForMethod
- Defined in packages/client/src/client/client.ts:581

`Protected`assertNotificationCapability

assertNotificationCapability(method: NotificationMethod): 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: NotificationMethod
Returns void
Overrides Protocol.assertNotificationCapability
- Defined in packages/client/src/client/client.ts:644

`Protected`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
Overrides Protocol.assertRequestHandlerCapability
- Defined in packages/client/src/client/client.ts:673

`Protected`assertTaskCapability

assertTaskCapability(method: string): void
A method to check if the remote side supports task creation for the given method.

Called when sending a task-augmented outbound request (only when enforceStrictCapabilities is true). This should be implemented by subclasses.
Parameters
- method: string
Returns void
Overrides Protocol.assertTaskCapability
- Defined in packages/client/src/client/client.ts:712

`Protected`assertTaskHandlerCapability

assertTaskHandlerCapability(method: string): void
A method to check if this side supports handling task creation for the given method.

Called when receiving a task-augmented inbound request. This should be implemented by subclasses.
Parameters
- method: string
Returns void
Overrides Protocol.assertTaskHandlerCapability
- Defined in packages/client/src/client/client.ts:716

`Protected`buildContext

buildContext(ctx: BaseContext, _transportInfo?: MessageExtraInfo): BaseContext
Builds the context object for request handlers. Subclasses must override to return the appropriate context type (e.g., ServerContext adds HTTP request info).
Parameters
- ctx: BaseContext
- Optional_transportInfo: MessageExtraInfo
Returns BaseContext
Overrides Protocol.buildContext
- Defined in packages/client/src/client/client.ts:248

callTool

callTool(
    params: {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        arguments?: { [key: string]: unknown };
        name: string;
        task?: { ttl?: number };
    },
    options?: RequestOptions,
): Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        content: (
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ("user" | "assistant")[];
                    lastModified?: string;
                    priority?: number;
                };
                text: string;
                type: "text";
            }
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ("user" | "assistant")[];
                    lastModified?: string;
                    priority?: number;
                };
                data: string;
                mimeType: string;
                type: "image";
            }
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ("user" | "assistant")[];
                    lastModified?: string;
                    priority?: number;
                };
                data: string;
                mimeType: string;
                type: "audio";
            }
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ("user" | "assistant")[];
                    lastModified?: string;
                    priority?: number;
                };
                resource: | {
                    _meta?: Record<string, unknown>;
                    mimeType?: string;
                    text: string;
                    uri: string;
                }
                | {
                    _meta?: Record<string, unknown>;
                    blob: string;
                    mimeType?: string;
                    uri: string;
                };
                type: "resource";
            }
            | {
                _meta?: { [key: string]: unknown };
                annotations?: {
                    audience?: ("user" | "assistant")[];
                    lastModified?: string;
                    priority?: number;
                };
                description?: string;
                icons?: {
                    mimeType?: string;
                    sizes?: string[];
                    src: string;
                    theme?: "light"
                    | "dark";
                }[];
                mimeType?: string;
                name: string;
                size?: number;
                title?: string;
                type: "resource_link";
                uri: string;
            }
        )[];
        isError?: boolean;
        structuredContent?: Record<string, unknown>;
        [key: string]: unknown;
    },
>
Calls a tool on the connected server and returns the result. Automatically validates structured output if the tool has an outputSchema.

Tool results have two error surfaces: result.isError for tool-level failures (the tool ran but reported a problem), and thrown ProtocolError for protocol-level failures or SdkError for SDK-level issues (timeouts, missing capabilities).

For task-based execution with streaming behavior, use client.experimental.tasks.callToolStream() instead.
Parameters
- params: {
      _meta?: {
          "io.modelcontextprotocol/related-task"?: { taskId: string };
          progressToken?: string | number;
          [key: string]: unknown;
      };
      arguments?: { [key: string]: unknown };
      name: string;
      task?: { ttl?: number };
  }
  - Optional_meta?: {
        "io.modelcontextprotocol/related-task"?: { taskId: string };
        progressToken?: string | number;
        [key: string]: unknown;
    }
    See General fields: _meta for notes on _meta usage.
    
    Optionalio.modelcontextprotocol/related-task?: { taskId: string }
    If specified, this request is related to the provided task.
    
    OptionalprogressToken?: string | number
    If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.
  - Optionalarguments?: { [key: string]: unknown }
    Arguments to pass to the tool.
  - name: string
    The name of the tool to call.
  - Optionaltask?: { ttl?: number }
    If specified, the caller is requesting task-augmented execution for this request. The request will return a CreateTaskResult immediately, and the actual result can be retrieved later via tasks/result.
    
    Task augmentation is subject to capability negotiation - receivers MUST declare support for task augmentation of specific request types in their capabilities.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        content: (
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ("user" | "assistant")[];
                    lastModified?: string;
                    priority?: number;
                };
                text: string;
                type: "text";
            }
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ("user" | "assistant")[];
                    lastModified?: string;
                    priority?: number;
                };
                data: string;
                mimeType: string;
                type: "image";
            }
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ("user" | "assistant")[];
                    lastModified?: string;
                    priority?: number;
                };
                data: string;
                mimeType: string;
                type: "audio";
            }
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ("user" | "assistant")[];
                    lastModified?: string;
                    priority?: number;
                };
                resource: | {
                    _meta?: Record<string, unknown>;
                    mimeType?: string;
                    text: string;
                    uri: string;
                }
                | {
                    _meta?: Record<string, unknown>;
                    blob: string;
                    mimeType?: string;
                    uri: string;
                };
                type: "resource";
            }
            | {
                _meta?: { [key: string]: unknown };
                annotations?: {
                    audience?: ("user" | "assistant")[];
                    lastModified?: string;
                    priority?: number;
                };
                description?: string;
                icons?: {
                    mimeType?: string;
                    sizes?: string[];
                    src: string;
                    theme?: "light"
                    | "dark";
                }[];
                mimeType?: string;
                name: string;
                size?: number;
                title?: string;
                type: "resource_link";
                uri: string;
            }
        )[];
        isError?: boolean;
        structuredContent?: Record<string, unknown>;
        [key: string]: unknown;
    },
>
Example: Basic usage
```
const result = await client.callTool({
    name: 'calculate-bmi',
    arguments: { weightKg: 70, heightM: 1.75 }
});

// Tool-level errors are returned in the result, not thrown
if (result.isError) {
    console.error('Tool error:', result.content);
    return;
}

console.log(result.content);
```
Example: Structured output
```
const result = await client.callTool({
    name: 'calculate-bmi',
    arguments: { weightKg: 70, heightM: 1.75 }
});

// Machine-readable output for the client application
if (result.structuredContent) {
    console.log(result.structuredContent); // e.g. { bmi: 22.86 }
}
```
- Defined in packages/client/src/client/client.ts:870

close

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

Returns Promise<void>
Inherited from Protocol.close
- Defined in packages/core/src/shared/protocol.ts:734

complete

complete(
    params: {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        argument: { name: string; value: string };
        context?: { arguments?: { [key: string]: string } };
        ref:
            | { type: "ref/resource"; uri: string }
            | { name: string; type: "ref/prompt" };
    },
    options?: RequestOptions,
): Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        completion: {
            hasMore?: boolean;
            total?: number;
            values: string[];
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
Requests argument autocompletion suggestions from the server for a prompt or resource.
Parameters
- params: {
      _meta?: {
          "io.modelcontextprotocol/related-task"?: { taskId: string };
          progressToken?: string | number;
          [key: string]: unknown;
      };
      argument: { name: string; value: string };
      context?: { arguments?: { [key: string]: string } };
      ref:
          | { type: "ref/resource"; uri: string }
          | { name: string; type: "ref/prompt" };
  }
  - Optional_meta?: {
        "io.modelcontextprotocol/related-task"?: { taskId: string };
        progressToken?: string | number;
        [key: string]: unknown;
    }
    See General fields: _meta for notes on _meta usage.
    
    Optionalio.modelcontextprotocol/related-task?: { taskId: string }
    If specified, this request is related to the provided task.
    
    OptionalprogressToken?: string | number
    If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.
  - argument: { name: string; value: string }
    The argument's information
    
    name: string
    The name of the argument
    
    value: string
    The value of the argument to use for completion matching.
  - Optionalcontext?: { arguments?: { [key: string]: string } }
    Optionalarguments?: { [key: string]: string }
    Previously-resolved variables in a URI template or prompt.
  - ref: { type: "ref/resource"; uri: string } | { name: string; type: "ref/prompt" }
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        completion: {
            hasMore?: boolean;
            total?: number;
            values: string[];
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
- Defined in packages/client/src/client/client.ts:725

connect

connect(transport: Transport, options?: RequestOptions): Promise<void>

Connects to a server via the given transport and performs the MCP initialization handshake.

Parameters

transport: Transport
Optionaloptions: RequestOptions

Returns Promise<void>

Example: Basic usage (stdio)

const client = new Client({ name: 'my-client', version: '1.0.0' });
const transport = new StdioClientTransport({ command: 'my-mcp-server' });
await client.connect(transport);

Example: Streamable HTTP with SSE fallback

const baseUrl = new URL(url);

try {
    // Try modern Streamable HTTP transport first
    const client = new Client({ name: 'my-client', version: '1.0.0' });
    const transport = new StreamableHTTPClientTransport(baseUrl);
    await client.connect(transport);
    return { client, transport };
} catch {
    // Fall back to legacy SSE transport
    const client = new Client({ name: 'my-client', version: '1.0.0' });
    const transport = new SSEClientTransport(baseUrl);
    await client.connect(transport);
    return { client, transport };
}

getInstructions

getInstructions(): string | undefined
After initialization has completed, this may be populated with information about the server's instructions.

Returns string | undefined
- Defined in packages/client/src/client/client.ts:577

getNegotiatedProtocolVersion

getNegotiatedProtocolVersion(): string | undefined
After initialization has completed, this will be populated with the protocol version negotiated during the initialize handshake. When manually reconstructing a transport for reconnection, pass this value to the new transport so it continues sending the required mcp-protocol-version header.

Returns string | undefined
- Defined in packages/client/src/client/client.ts:570

getPrompt

getPrompt(
    params: {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        arguments?: { [key: string]: string };
        name: string;
    },
    options?: RequestOptions,
): Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        description?: string;
        messages: {
            content: | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ((...) | (...))[];
                    lastModified?: string;
                    priority?: number;
                };
                text: string;
                type: "text";
            }
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ((...) | (...))[];
                    lastModified?: string;
                    priority?: number;
                };
                data: string;
                mimeType: string;
                type: "image";
            }
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ((...) | (...))[];
                    lastModified?: string;
                    priority?: number;
                };
                data: string;
                mimeType: string;
                type: "audio";
            }
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ((...) | (...))[];
                    lastModified?: string;
                    priority?: number;
                };
                resource: | {
                    _meta?: Record<string, unknown>;
                    mimeType?: string;
                    text: string;
                    uri: string;
                }
                | {
                    _meta?: Record<string, unknown>;
                    blob: string;
                    mimeType?: string;
                    uri: string;
                };
                type: "resource";
            }
            | {
                _meta?: { [key: string]: unknown };
                annotations?: {
                    audience?: ((...) | (...))[];
                    lastModified?: string;
                    priority?: number;
                };
                description?: string;
                icons?: {
                    mimeType?: string;
                    sizes?: (...)[];
                    src: string;
                    theme?: "light" | "dark";
                }[];
                mimeType?: string;
                name: string;
                size?: number;
                title?: string;
                type: "resource_link";
                uri: string;
            };
            role: "user"
            | "assistant";
        }[];
        [key: string]: unknown;
    },
>
Retrieves a prompt by name from the server, passing the given arguments for template substitution.
Parameters
- params: {
      _meta?: {
          "io.modelcontextprotocol/related-task"?: { taskId: string };
          progressToken?: string | number;
          [key: string]: unknown;
      };
      arguments?: { [key: string]: string };
      name: string;
  }
  - Optional_meta?: {
        "io.modelcontextprotocol/related-task"?: { taskId: string };
        progressToken?: string | number;
        [key: string]: unknown;
    }
    See General fields: _meta for notes on _meta usage.
    
    Optionalio.modelcontextprotocol/related-task?: { taskId: string }
    If specified, this request is related to the provided task.
    
    OptionalprogressToken?: string | number
    If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.
  - Optionalarguments?: { [key: string]: string }
    Arguments to use for templating the prompt.
  - name: string
    The name of the prompt or prompt template.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        description?: string;
        messages: {
            content: | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ((...) | (...))[];
                    lastModified?: string;
                    priority?: number;
                };
                text: string;
                type: "text";
            }
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ((...) | (...))[];
                    lastModified?: string;
                    priority?: number;
                };
                data: string;
                mimeType: string;
                type: "image";
            }
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ((...) | (...))[];
                    lastModified?: string;
                    priority?: number;
                };
                data: string;
                mimeType: string;
                type: "audio";
            }
            | {
                _meta?: Record<string, unknown>;
                annotations?: {
                    audience?: ((...) | (...))[];
                    lastModified?: string;
                    priority?: number;
                };
                resource: | {
                    _meta?: Record<string, unknown>;
                    mimeType?: string;
                    text: string;
                    uri: string;
                }
                | {
                    _meta?: Record<string, unknown>;
                    blob: string;
                    mimeType?: string;
                    uri: string;
                };
                type: "resource";
            }
            | {
                _meta?: { [key: string]: unknown };
                annotations?: {
                    audience?: ((...) | (...))[];
                    lastModified?: string;
                    priority?: number;
                };
                description?: string;
                icons?: {
                    mimeType?: string;
                    sizes?: (...)[];
                    src: string;
                    theme?: "light" | "dark";
                }[];
                mimeType?: string;
                name: string;
                size?: number;
                title?: string;
                type: "resource_link";
                uri: string;
            };
            role: "user"
            | "assistant";
        }[];
        [key: string]: unknown;
    },
>
- Defined in packages/client/src/client/client.ts:735

getServerCapabilities

getServerCapabilities(): | {
    completions?: {
        [key: string]: | string
        | number
        | boolean
        | (
            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
        )
        | (
            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
        )[]
        | null;
    };
    experimental?: {
        [key: string]: {
            [key: string]: | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
        };
    };
    extensions?: {
        [key: string]: {
            [key: string]: | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
        };
    };
    logging?: {
        [key: string]: | string
        | number
        | boolean
        | (
            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
        )
        | (
            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
        )[]
        | null;
    };
    prompts?: { listChanged?: boolean };
    resources?: { listChanged?: boolean; subscribe?: boolean };
    tasks?: {
        cancel?: {
            [key: string]:
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
        };
        list?: {
            [key: string]: | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
        };
        requests?: {
            tools?: {
                call?: {
                    [key: string]: (...)
                    | (...)
                    | (...)
                    | (...)
                    | (...)
                    | (...)
                    | (...);
                };
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        [key: string]: unknown;
    };
    tools?: { listChanged?: boolean };
}
| undefined
After initialization has completed, this will be populated with the server's reported capabilities.

Returns
    | {
        completions?: {
            [key: string]: | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
        };
        experimental?: {
            [key: string]: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
        };
        extensions?: {
            [key: string]: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
        };
        logging?: {
            [key: string]: | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
        };
        prompts?: { listChanged?: boolean };
        resources?: { listChanged?: boolean; subscribe?: boolean };
        tasks?: {
            cancel?: {
                [key: string]:
                    | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[]
                    | null;
            };
            list?: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
            requests?: {
                tools?: {
                    call?: {
                        [key: string]: | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    };
                    [key: string]: unknown;
                };
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        tools?: { listChanged?: boolean };
    }
    | undefined
- {
      completions?: {
          [key: string]:
              | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[]
              | null;
      };
      experimental?: {
          [key: string]: {
              [key: string]: | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[]
              | null;
          };
      };
      extensions?: {
          [key: string]: {
              [key: string]: | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[]
              | null;
          };
      };
      logging?: {
          [key: string]: | string
          | number
          | boolean
          | (
              { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
          )
          | (
              string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
          )[]
          | null;
      };
      prompts?: { listChanged?: boolean };
      resources?: { listChanged?: boolean; subscribe?: boolean };
      tasks?: {
          cancel?: {
              [key: string]:
                  | string
                  | number
                  | boolean
                  | (
                      { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                  )
                  | (
                      string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                  )[]
                  | null;
          };
          list?: {
              [key: string]: | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[]
              | null;
          };
          requests?: {
              tools?: {
                  call?: {
                      [key: string]: (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  };
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          };
          [key: string]: unknown;
      };
      tools?: { listChanged?: boolean };
  }
  - Optionalcompletions?: {
        [key: string]:
            | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
    }
    Present if the server supports sending completions to the client.
  - Optionalexperimental?: {
        [key: string]: {
            [key: string]:
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
        };
    }
    Experimental, non-standard capabilities that the server supports.
  - Optionalextensions?: {
        [key: string]: {
            [key: string]:
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
        };
    }
    Extensions that the server supports. Keys are extension identifiers (vendor-prefix/extension-name).
  - Optionallogging?: {
        [key: string]:
            | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
    }
    Present if the server supports sending log messages to the client.
  - Optionalprompts?: { listChanged?: boolean }
    Present if the server offers any prompt templates.
    - OptionallistChanged?: boolean
      Whether this server supports issuing notifications for changes to the prompt list.
  - Optionalresources?: { listChanged?: boolean; subscribe?: boolean }
    Present if the server offers any resources to read.
    - OptionallistChanged?: boolean
      Whether this server supports issuing notifications for changes to the resource list.
    - Optionalsubscribe?: boolean
      Whether this server supports clients subscribing to resource updates.
  - Optionaltasks?: {
        cancel?: {
            [key: string]:
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
        };
        list?: {
            [key: string]: | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
        };
        requests?: {
            tools?: {
                call?: {
                    [key: string]: (...)
                    | (...)
                    | (...)
                    | (...)
                    | (...)
                    | (...)
                    | (...);
                };
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        [key: string]: unknown;
    }
    Present if the server supports task creation.
    - Optionalcancel?: {
          [key: string]:
              | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[]
              | null;
      }
      Present if the server supports cancelling tasks.
    - Optionallist?: {
          [key: string]:
              | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[]
              | null;
      }
      Present if the server supports listing tasks.
    - Optionalrequests?: {
          tools?: {
              call?: {
                  [key: string]: (...) | (...) | (...) | (...) | (...) | (...) | (...);
              };
              [key: string]: unknown;
          };
          [key: string]: unknown;
      }
      Capabilities for task creation on specific request types.
      
      Optionaltools?: {
          call?: {
              [key: string]: (...) | (...) | (...) | (...) | (...) | (...) | (...);
          };
          [key: string]: unknown;
      }
      Task support for tool requests.
  - Optionaltools?: { listChanged?: boolean }
    Present if the server offers any tools to call.
    - OptionallistChanged?: boolean
      Whether this server supports issuing notifications for changes to the tool list.
- undefined
- Defined in packages/client/src/client/client.ts:554

getServerVersion

getServerVersion(): | {
    description?: string;
    icons?: {
        mimeType?: string;
        sizes?: string[];
        src: string;
        theme?: "light"
        | "dark";
    }[];
    name: string;
    title?: string;
    version: string;
    websiteUrl?: string;
}
| undefined
After initialization has completed, this will be populated with information about the server's name and version.

Returns
    | {
        description?: string;
        icons?: {
            mimeType?: string;
            sizes?: string[];
            src: string;
            theme?: "light"
            | "dark";
        }[];
        name: string;
        title?: string;
        version: string;
        websiteUrl?: string;
    }
    | undefined
- {
      description?: string;
      icons?: {
          mimeType?: string;
          sizes?: string[];
          src: string;
          theme?: "light" | "dark";
      }[];
      name: string;
      title?: string;
      version: string;
      websiteUrl?: string;
  }
  - Optionaldescription?: string
    An optional human-readable description of what this implementation does.
    
    This can be used by clients or servers to provide context about their purpose and capabilities. For example, a server might describe the types of resources or tools it provides, while a client might describe its intended use case.
  - Optionalicons?: { mimeType?: string; sizes?: string[]; src: string; theme?: "light" | "dark" }[]
    Optional set of sized icons that the client can display in a user interface.
    
    Clients that support rendering icons MUST support at least the following MIME types:
    
    image/png - PNG images (safe, universal compatibility)
    
    image/jpeg (and image/jpg) - JPEG images (safe, universal compatibility)
    
    Clients that support rendering icons SHOULD also support:
    
    image/svg+xml - SVG images (scalable but requires security precautions)
    
    image/webp - WebP images (modern, efficient format)
  - name: string
    Intended for programmatic or logical use, but used as a display name in past specs or fallback
  - Optionaltitle?: string
    Intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology.
    
    If not provided, the name should be used for display (except for Tool, where annotations.title should be given precedence over using name, if present).
  - version: string
  - OptionalwebsiteUrl?: string
    An optional URL of the website for this implementation.
- undefined
- Defined in packages/client/src/client/client.ts:561

listPrompts

listPrompts(
    params?: {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        cursor?: string;
    },
    options?: RequestOptions,
): Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        nextCursor?: string;
        prompts: {
            _meta?: { [key: string]: unknown };
            arguments?: { description?: string; name: string; required?: boolean }[];
            description?: string;
            icons?: {
                mimeType?: string;
                sizes?: string[];
                src: string;
                theme?: "light" | "dark";
            }[];
            name: string;
            title?: string;
        }[];
        [key: string]: unknown;
    },
>
Lists available prompts. Results may be paginated — loop on nextCursor to collect all pages.

Returns an empty list if the server does not advertise prompts capability (or throws if ClientOptions.enforceStrictCapabilities is enabled).
Parameters
- Optionalparams: {
      _meta?: {
          "io.modelcontextprotocol/related-task"?: { taskId: string };
          progressToken?: string | number;
          [key: string]: unknown;
      };
      cursor?: string;
  }
  - Optional_meta?: {
        "io.modelcontextprotocol/related-task"?: { taskId: string };
        progressToken?: string | number;
        [key: string]: unknown;
    }
    See General fields: _meta for notes on _meta usage.
    
    Optionalio.modelcontextprotocol/related-task?: { taskId: string }
    If specified, this request is related to the provided task.
    
    OptionalprogressToken?: string | number
    If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.
  - Optionalcursor?: string
    An opaque token representing the current pagination position. If provided, the server should return results starting after this cursor.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        nextCursor?: string;
        prompts: {
            _meta?: { [key: string]: unknown };
            arguments?: { description?: string; name: string; required?: boolean }[];
            description?: string;
            icons?: {
                mimeType?: string;
                sizes?: string[];
                src: string;
                theme?: "light" | "dark";
            }[];
            name: string;
            title?: string;
        }[];
        [key: string]: unknown;
    },
>
Example
```
const allPrompts: Prompt[] = [];
let cursor: string | undefined;
do {
    const { prompts, nextCursor } = await client.listPrompts({ cursor });
    allPrompts.push(...prompts);
    cursor = nextCursor;
} while (cursor);
console.log(
    'Available prompts:',
    allPrompts.map(p => p.name)
);
```
- Defined in packages/client/src/client/client.ts:760

listResources

listResources(
    params?: {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        cursor?: string;
    },
    options?: RequestOptions,
): Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        nextCursor?: string;
        resources: {
            _meta?: { [key: string]: unknown };
            annotations?: {
                audience?: ("user" | "assistant")[];
                lastModified?: string;
                priority?: number;
            };
            description?: string;
            icons?: {
                mimeType?: string;
                sizes?: string[];
                src: string;
                theme?: "light"
                | "dark";
            }[];
            mimeType?: string;
            name: string;
            size?: number;
            title?: string;
            uri: string;
        }[];
        [key: string]: unknown;
    },
>
Lists available resources. Results may be paginated — loop on nextCursor to collect all pages.

Returns an empty list if the server does not advertise resources capability (or throws if ClientOptions.enforceStrictCapabilities is enabled).
Parameters
- Optionalparams: {
      _meta?: {
          "io.modelcontextprotocol/related-task"?: { taskId: string };
          progressToken?: string | number;
          [key: string]: unknown;
      };
      cursor?: string;
  }
  - Optional_meta?: {
        "io.modelcontextprotocol/related-task"?: { taskId: string };
        progressToken?: string | number;
        [key: string]: unknown;
    }
    See General fields: _meta for notes on _meta usage.
    
    Optionalio.modelcontextprotocol/related-task?: { taskId: string }
    If specified, this request is related to the provided task.
    
    OptionalprogressToken?: string | number
    If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.
  - Optionalcursor?: string
    An opaque token representing the current pagination position. If provided, the server should return results starting after this cursor.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        nextCursor?: string;
        resources: {
            _meta?: { [key: string]: unknown };
            annotations?: {
                audience?: ("user" | "assistant")[];
                lastModified?: string;
                priority?: number;
            };
            description?: string;
            icons?: {
                mimeType?: string;
                sizes?: string[];
                src: string;
                theme?: "light"
                | "dark";
            }[];
            mimeType?: string;
            name: string;
            size?: number;
            title?: string;
            uri: string;
        }[];
        [key: string]: unknown;
    },
>
Example
```
const allResources: Resource[] = [];
let cursor: string | undefined;
do {
    const { resources, nextCursor } = await client.listResources({ cursor });
    allResources.push(...resources);
    cursor = nextCursor;
} while (cursor);
console.log(
    'Available resources:',
    allResources.map(r => r.name)
);
```
- Defined in packages/client/src/client/client.ts:790

listResourceTemplates

listResourceTemplates(
    params?: {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        cursor?: string;
    },
    options?: RequestOptions,
): Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        nextCursor?: string;
        resourceTemplates: {
            _meta?: { [key: string]: unknown };
            annotations?: {
                audience?: ("user" | "assistant")[];
                lastModified?: string;
                priority?: number;
            };
            description?: string;
            icons?: {
                mimeType?: string;
                sizes?: string[];
                src: string;
                theme?: "light"
                | "dark";
            }[];
            mimeType?: string;
            name: string;
            title?: string;
            uriTemplate: string;
        }[];
        [key: string]: unknown;
    },
>
Lists available resource URI templates for dynamic resources. Results may be paginated — see listResources() for the cursor pattern.

Returns an empty list if the server does not advertise resources capability (or throws if ClientOptions.enforceStrictCapabilities is enabled).
Parameters
- Optionalparams: {
      _meta?: {
          "io.modelcontextprotocol/related-task"?: { taskId: string };
          progressToken?: string | number;
          [key: string]: unknown;
      };
      cursor?: string;
  }
  - Optional_meta?: {
        "io.modelcontextprotocol/related-task"?: { taskId: string };
        progressToken?: string | number;
        [key: string]: unknown;
    }
    See General fields: _meta for notes on _meta usage.
    
    Optionalio.modelcontextprotocol/related-task?: { taskId: string }
    If specified, this request is related to the provided task.
    
    OptionalprogressToken?: string | number
    If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.
  - Optionalcursor?: string
    An opaque token representing the current pagination position. If provided, the server should return results starting after this cursor.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        nextCursor?: string;
        resourceTemplates: {
            _meta?: { [key: string]: unknown };
            annotations?: {
                audience?: ("user" | "assistant")[];
                lastModified?: string;
                priority?: number;
            };
            description?: string;
            icons?: {
                mimeType?: string;
                sizes?: string[];
                src: string;
                theme?: "light"
                | "dark";
            }[];
            mimeType?: string;
            name: string;
            title?: string;
            uriTemplate: string;
        }[];
        [key: string]: unknown;
    },
>
- Defined in packages/client/src/client/client.ts:805

listTools

listTools(
    params?: {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        cursor?: string;
    },
    options?: RequestOptions,
): Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        nextCursor?: string;
        tools: {
            _meta?: Record<string, unknown>;
            annotations?: {
                destructiveHint?: boolean;
                idempotentHint?: boolean;
                openWorldHint?: boolean;
                readOnlyHint?: boolean;
                title?: string;
            };
            description?: string;
            execution?: { taskSupport?: "optional"
            | "required"
            | "forbidden" };
            icons?: {
                mimeType?: string;
                sizes?: string[];
                src: string;
                theme?: "light" | "dark";
            }[];
            inputSchema: {
                properties?: Record<string, JSONValue>;
                required?: string[];
                type: "object";
                [key: string]: unknown;
            };
            name: string;
            outputSchema?: {
                properties?: Record<string, JSONValue>;
                required?: string[];
                type: "object";
                [key: string]: unknown;
            };
            title?: string;
        }[];
        [key: string]: unknown;
    },
>
Lists available tools. Results may be paginated — loop on nextCursor to collect all pages.

Returns an empty list if the server does not advertise tools capability (or throws if ClientOptions.enforceStrictCapabilities is enabled).
Parameters
- Optionalparams: {
      _meta?: {
          "io.modelcontextprotocol/related-task"?: { taskId: string };
          progressToken?: string | number;
          [key: string]: unknown;
      };
      cursor?: string;
  }
  - Optional_meta?: {
        "io.modelcontextprotocol/related-task"?: { taskId: string };
        progressToken?: string | number;
        [key: string]: unknown;
    }
    See General fields: _meta for notes on _meta usage.
    
    Optionalio.modelcontextprotocol/related-task?: { taskId: string }
    If specified, this request is related to the provided task.
    
    OptionalprogressToken?: string | number
    If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.
  - Optionalcursor?: string
    An opaque token representing the current pagination position. If provided, the server should return results starting after this cursor.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        nextCursor?: string;
        tools: {
            _meta?: Record<string, unknown>;
            annotations?: {
                destructiveHint?: boolean;
                idempotentHint?: boolean;
                openWorldHint?: boolean;
                readOnlyHint?: boolean;
                title?: string;
            };
            description?: string;
            execution?: { taskSupport?: "optional"
            | "required"
            | "forbidden" };
            icons?: {
                mimeType?: string;
                sizes?: string[];
                src: string;
                theme?: "light" | "dark";
            }[];
            inputSchema: {
                properties?: Record<string, JSONValue>;
                required?: string[];
                type: "object";
                [key: string]: unknown;
            };
            name: string;
            outputSchema?: {
                properties?: Record<string, JSONValue>;
                required?: string[];
                type: "object";
                [key: string]: unknown;
            };
            title?: string;
        }[];
        [key: string]: unknown;
    },
>
Example
```
const allTools: Tool[] = [];
let cursor: string | undefined;
do {
    const { tools, nextCursor } = await client.listTools({ cursor });
    allTools.push(...tools);
    cursor = nextCursor;
} while (cursor);
console.log(
    'Available tools:',
    allTools.map(t => t.name)
);
```
- Defined in packages/client/src/client/client.ts:990

notification

notification(
    notification: {
        method: string;
        params?: {
            _meta?: {
                "io.modelcontextprotocol/related-task"?: { taskId: string };
                progressToken?: string | number;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
    },
    options?: NotificationOptions,
): Promise<void>
Emits a notification, which is a one-way message that does not expect a response.
Parameters
- notification: {
      method: string;
      params?: {
          _meta?: {
              "io.modelcontextprotocol/related-task"?: { taskId: string };
              progressToken?: string | number;
              [key: string]: unknown;
          };
          [key: string]: unknown;
      };
  }
- Optionaloptions: NotificationOptions
Returns Promise<void>
Inherited from Protocol.notification
- Defined in packages/core/src/shared/protocol.ts:948

ping

ping(
    options?: RequestOptions,
): Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
    },
>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
    },
>
- Defined in packages/client/src/client/client.ts:720

readResource

readResource(
    params: {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        uri: string;
    },
    options?: RequestOptions,
): Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        contents: (
            | {
                _meta?: Record<string, unknown>;
                mimeType?: string;
                text: string;
                uri: string;
            }
            | {
                _meta?: Record<string, unknown>;
                blob: string;
                mimeType?: string;
                uri: string;
            }
        )[];
        [key: string]: unknown;
    },
>
Reads the contents of a resource by URI.
Parameters
- params: {
      _meta?: {
          "io.modelcontextprotocol/related-task"?: { taskId: string };
          progressToken?: string | number;
          [key: string]: unknown;
      };
      uri: string;
  }
  - Optional_meta?: {
        "io.modelcontextprotocol/related-task"?: { taskId: string };
        progressToken?: string | number;
        [key: string]: unknown;
    }
    See General fields: _meta for notes on _meta usage.
    
    Optionalio.modelcontextprotocol/related-task?: { taskId: string }
    If specified, this request is related to the provided task.
    
    OptionalprogressToken?: string | number
    If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.
  - uri: string
    The URI of the resource to read. The URI can use any protocol; it is up to the server how to interpret it.
    
    Format
    uri
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        contents: (
            | {
                _meta?: Record<string, unknown>;
                mimeType?: string;
                text: string;
                uri: string;
            }
            | {
                _meta?: Record<string, unknown>;
                blob: string;
                mimeType?: string;
                uri: string;
            }
        )[];
        [key: string]: unknown;
    },
>
- Defined in packages/client/src/client/client.ts:817

registerCapabilities

registerCapabilities(
    capabilities: {
        elicitation?: {
            form?: {
                applyDefaults?: boolean;
                [key: string]:
                    | string
                    | number
                    | boolean
                    | {
                        [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                    }
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[]
                    | null;
            };
            url?: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
            [key: string]: | string
            | number
            | boolean
            | {
                [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
            }
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
        };
        experimental?: {
            [key: string]: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
        };
        extensions?: {
            [key: string]: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
        };
        roots?: { listChanged?: boolean };
        sampling?: {
            context?: {
                [key: string]:
                    | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[]
                    | null;
            };
            tools?: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
        };
        tasks?: {
            cancel?: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
            list?: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
            };
            requests?: {
                elicitation?: {
                    create?: {
                        [key: string]: | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (...)[]
                        | null;
                    };
                    [key: string]: unknown;
                };
                sampling?: {
                    createMessage?: {
                        [key: string]: | string
                        | number
                        | boolean
                        | (
                            { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                        )
                        | (...)[]
                        | null;
                    };
                    [key: string]: unknown;
                };
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
    },
): void
Registers new capabilities. This can only be called before connecting to a transport.

The new capabilities will be merged with any existing capabilities previously given (e.g., at initialization).
Parameters
- capabilities: {
      elicitation?: {
          form?: {
              applyDefaults?: boolean;
              [key: string]:
                  | string
                  | number
                  | boolean
                  | {
                      [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                  }
                  | (
                      string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                  )[]
                  | null;
          };
          url?: {
              [key: string]: | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[]
              | null;
          };
          [key: string]: | string
          | number
          | boolean
          | {
              [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
          }
          | (
              string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
          )[]
          | null;
      };
      experimental?: {
          [key: string]: {
              [key: string]: | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[]
              | null;
          };
      };
      extensions?: {
          [key: string]: {
              [key: string]: | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[]
              | null;
          };
      };
      roots?: { listChanged?: boolean };
      sampling?: {
          context?: {
              [key: string]:
                  | string
                  | number
                  | boolean
                  | (
                      { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                  )
                  | (
                      string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                  )[]
                  | null;
          };
          tools?: {
              [key: string]: | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[]
              | null;
          };
      };
      tasks?: {
          cancel?: {
              [key: string]: | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[]
              | null;
          };
          list?: {
              [key: string]: | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[]
              | null;
          };
          requests?: {
              elicitation?: {
                  create?: {
                      [key: string]: | string
                      | number
                      | boolean
                      | (
                          { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                      )
                      | (...)[]
                      | null;
                  };
                  [key: string]: unknown;
              };
              sampling?: {
                  createMessage?: {
                      [key: string]: | string
                      | number
                      | boolean
                      | (
                          { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                      )
                      | (...)[]
                      | null;
                  };
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          };
          [key: string]: unknown;
      };
  }
  - Optionalelicitation?: {
        form?: {
            applyDefaults?: boolean;
            [key: string]:
                | string
                | number
                | boolean
                | {
                    [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                }
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
        };
        url?: {
            [key: string]: | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
        };
        [key: string]: | string
        | number
        | boolean
        | {
            [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
        }
        | (
            string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
        )[]
        | null;
    }
    Present if the client supports eliciting user input.
  - Optionalexperimental?: {
        [key: string]: {
            [key: string]:
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
        };
    }
    Experimental, non-standard capabilities that the client supports.
  - Optionalextensions?: {
        [key: string]: {
            [key: string]:
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
        };
    }
    Extensions that the client supports. Keys are extension identifiers (vendor-prefix/extension-name).
  - Optionalroots?: { listChanged?: boolean }
    Present if the client supports listing roots.
    
    OptionallistChanged?: boolean
    Whether the client supports issuing notifications for changes to the roots list.
  - Optionalsampling?: {
        context?: {
            [key: string]:
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
        };
        tools?: {
            [key: string]: | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
        };
    }
    Present if the client supports sampling from an LLM.
    
    Optionalcontext?: {
        [key: string]:
            | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
    }
    Present if the client supports context inclusion via includeContext parameter. If not declared, servers SHOULD only use includeContext: "none" (or omit it).
    
    Optionaltools?: {
        [key: string]:
            | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
    }
    Present if the client supports tool use via tools and toolChoice parameters.
  - Optionaltasks?: {
        cancel?: {
            [key: string]:
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
        };
        list?: {
            [key: string]: | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
        };
        requests?: {
            elicitation?: {
                create?: {
                    [key: string]: | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (...)[]
                    | null;
                };
                [key: string]: unknown;
            };
            sampling?: {
                createMessage?: {
                    [key: string]: | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (...)[]
                    | null;
                };
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        [key: string]: unknown;
    }
    Present if the client supports task creation.
    
    Optionalcancel?: {
        [key: string]:
            | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
    }
    Present if the client supports cancelling tasks.
    
    Optionallist?: {
        [key: string]:
            | string
            | number
            | boolean
            | (
                { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
            )
            | (
                string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
            )[]
            | null;
    }
    Present if the client supports listing tasks.
    
    Optionalrequests?: {
        elicitation?: {
            create?: {
                [key: string]:
                    | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (...)[]
                    | null;
            };
            [key: string]: unknown;
        };
        sampling?: {
            createMessage?: {
                [key: string]: | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (...)[]
                | null;
            };
            [key: string]: unknown;
        };
        [key: string]: unknown;
    }
    Capabilities for task creation on specific request types.
    
    Optionalelicitation?: {
        create?: {
            [key: string]:
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (...)[]
                | null;
        };
        [key: string]: unknown;
    }
    Task support for elicitation requests.
    
    Optionalsampling?: {
        createMessage?: {
            [key: string]:
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (...)[]
                | null;
        };
        [key: string]: unknown;
    }
    Task support for sampling requests.
Returns void
- Defined in packages/client/src/client/client.ts:302

removeNotificationHandler

removeNotificationHandler(method: NotificationMethod): void
Removes the notification handler for the given method.
Parameters
- method: NotificationMethod
Returns void
Inherited from Protocol.removeNotificationHandler
- Defined in packages/core/src/shared/protocol.ts:1057

removeRequestHandler

removeRequestHandler(method: RequestMethod): void
Removes the request handler for the given method.
Parameters
- method: RequestMethod
Returns void
Inherited from Protocol.removeRequestHandler
- Defined in packages/core/src/shared/protocol.ts:1024

request

request<M extends RequestMethod>(
request: { method: M; params?: Record<string, unknown> },
options?: RequestOptions,
): Promise<ResultTypeMap[M]>
Sends a request and waits for a response, resolving the result schema automatically from the method name.

Do not use this method to emit notifications! Use notification() instead.
Type Parameters
- M extends RequestMethod
Parameters
- request: { method: M; params?: Record<string, unknown> }
- Optionaloptions: RequestOptions
Returns Promise<ResultTypeMap[M]>
Inherited from Protocol.request
- Defined in packages/core/src/shared/protocol.ts:781

sendRootsListChanged

sendRootsListChanged(): Promise<void>
Notifies the server that the client's root list has changed. Requires the roots.listChanged capability.

Returns Promise<void>
- Defined in packages/client/src/client/client.ts:1065

setLoggingLevel

setLoggingLevel(
    level: LoggingLevel,
    options?: RequestOptions,
): Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
    },
>
Sets the minimum severity level for log messages sent by the server.
Parameters
- level: LoggingLevel
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
    },
>
- Defined in packages/client/src/client/client.ts:730

setNotificationHandler

setNotificationHandler<M extends NotificationMethod>(
method: M,
handler: (notification: NotificationTypeMap[M]) => 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
- M extends NotificationMethod
Parameters
- method: M
- handler: (notification: NotificationTypeMap[M]) => void | Promise<void>
Returns void
Inherited from Protocol.setNotificationHandler
- Defined in packages/core/src/shared/protocol.ts:1042

setRequestHandler

setRequestHandler<M extends RequestMethod>(
    method: M,
    handler: (
        request: RequestTypeMap[M],
        ctx: BaseContext,
    ) => ResultTypeMap[M] | Promise<ResultTypeMap[M]>,
): void
Registers a handler for server-initiated requests (sampling, elicitation, roots). The client must declare the corresponding capability for the handler to be accepted. Replaces any previously registered handler for the same method.

For sampling/createMessage and elicitation/create, the handler is automatically wrapped with schema validation for both the incoming request and the returned result.
Type Parameters
- M extends RequestMethod
Parameters
- method: M
- handler: (
  request: RequestTypeMap[M],
  ctx: BaseContext,
  ) => ResultTypeMap[M] | Promise<ResultTypeMap[M]>
Returns void
Example: Handling a sampling request
```
client.setRequestHandler('sampling/createMessage', async request => {
    const lastMessage = request.params.messages.at(-1);
    console.log('Sampling request:', lastMessage);

    // In production, send messages to your LLM here
    return {
        model: 'my-model',
        role: 'assistant' as const,
        content: {
            type: 'text' as const,
            text: 'Response from the model'
        }
    };
});
```
Overrides Protocol.setRequestHandler
- Defined in packages/client/src/client/client.ts:336

subscribeResource

subscribeResource(
    params: {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        uri: string;
    },
    options?: RequestOptions,
): Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
    },
>
Subscribes to change notifications for a resource. The server must support resource subscriptions.
Parameters
- params: {
      _meta?: {
          "io.modelcontextprotocol/related-task"?: { taskId: string };
          progressToken?: string | number;
          [key: string]: unknown;
      };
      uri: string;
  }
  - Optional_meta?: {
        "io.modelcontextprotocol/related-task"?: { taskId: string };
        progressToken?: string | number;
        [key: string]: unknown;
    }
    See General fields: _meta for notes on _meta usage.
    
    Optionalio.modelcontextprotocol/related-task?: { taskId: string }
    If specified, this request is related to the provided task.
    
    OptionalprogressToken?: string | number
    If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.
  - uri: string
    The URI of the resource to read. The URI can use any protocol; it is up to the server how to interpret it.
    
    Format
    uri
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
    },
>
- Defined in packages/client/src/client/client.ts:822

unsubscribeResource

unsubscribeResource(
    params: {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        uri: string;
    },
    options?: RequestOptions,
): Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
    },
>
Unsubscribes from change notifications for a resource.
Parameters
- params: {
      _meta?: {
          "io.modelcontextprotocol/related-task"?: { taskId: string };
          progressToken?: string | number;
          [key: string]: unknown;
      };
      uri: string;
  }
  - Optional_meta?: {
        "io.modelcontextprotocol/related-task"?: { taskId: string };
        progressToken?: string | number;
        [key: string]: unknown;
    }
    See General fields: _meta for notes on _meta usage.
    
    Optionalio.modelcontextprotocol/related-task?: { taskId: string }
    If specified, this request is related to the provided task.
    
    OptionalprogressToken?: string | number
    If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.
  - uri: string
    The URI of the resource to read. The URI can use any protocol; it is up to the server how to interpret it.
    
    Format
    uri
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
    },
>
- Defined in packages/client/src/client/client.ts:827

Class Client

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optionaldescription?: string

Optionalicons?: { mimeType?: string; sizes?: string[]; src: string; theme?: "light" | "dark" }[]

name: string

Optionaltitle?: string

version: string

OptionalwebsiteUrl?: string

Returns Client

Properties

Protected_supportedProtocolVersions

OptionalfallbackNotificationHandler

OptionalfallbackRequestHandler

Optionalonclose

Optionalonerror

Accessors

experimental

Returns { tasks: ExperimentalClientTasks }

taskManager

Returns TaskManager

transport

Returns Transport | undefined

Methods

Protected_requestWithSchema

Type Parameters

Parameters

Returns Promise<SchemaOutput<T>>

assertCanSetRequestHandler

Parameters

Returns void

ProtectedassertCapability

Parameters

Returns void

ProtectedassertCapabilityForMethod

Parameters

Returns void

ProtectedassertNotificationCapability

Parameters

Returns void

ProtectedassertRequestHandlerCapability

Parameters

Returns void

ProtectedassertTaskCapability

Parameters

Returns void

ProtectedassertTaskHandlerCapability

Parameters

Returns void

ProtectedbuildContext

Parameters

Returns BaseContext

callTool

Parameters

Optional_meta?: { "io.modelcontextprotocol/related-task"?: { taskId: string }; progressToken?: string | number; [key: string]: unknown;}

Optionalio.modelcontextprotocol/related-task?: { taskId: string }

OptionalprogressToken?: string | number

Optionalarguments?: { [key: string]: unknown }

name: string

Optionaltask?: { ttl?: number }

Example: Basic usage

Example: Structured output

close

Returns Promise<void>

complete

Parameters

Optional_meta?: { "io.modelcontextprotocol/related-task"?: { taskId: string }; progressToken?: string | number; [key: string]: unknown;}

Optionalio.modelcontextprotocol/related-task?: { taskId: string }

OptionalprogressToken?: string | number

argument: { name: string; value: string }

name: string

value: string

Optionalcontext?: { arguments?: { [key: string]: string } }

`Optional`description?: string

`Optional`icons?: { mimeType?: string; sizes?: string[]; src: string; theme?: "light" | "dark" }[]

`Optional`title?: string

`Optional`websiteUrl?: string

`Protected`_supportedProtocolVersions

`Optional`fallbackNotificationHandler

`Optional`fallbackRequestHandler

`Optional`onclose

`Optional`onerror

`Protected`_requestWithSchema

`Protected`assertCapability

`Protected`assertCapabilityForMethod

`Protected`assertNotificationCapability

`Protected`assertRequestHandlerCapability

`Protected`assertTaskCapability

`Protected`assertTaskHandlerCapability

`Protected`buildContext

`Optional`_meta?: {
"io.modelcontextprotocol/related-task"?: { taskId: string };
progressToken?: string | number;
[key: string]: unknown;
}

`Optional`io.modelcontextprotocol/related-task?: { taskId: string }

`Optional`progressToken?: string | number

`Optional`arguments?: { [key: string]: unknown }

`Optional`task?: { ttl?: number }

`Optional`_meta?: {
"io.modelcontextprotocol/related-task"?: { taskId: string };
progressToken?: string | number;
[key: string]: unknown;
}

`Optional`io.modelcontextprotocol/related-task?: { taskId: string }

`Optional`progressToken?: string | number

`Optional`context?: { arguments?: { [key: string]: string } }

`Optional`arguments?: { [key: string]: string }

Returns Promise<
{
_meta?: {
"io.modelcontextprotocol/related-task"?: { taskId: string };
progressToken?: string | number;
[key: string]: unknown;
};
completion: {
hasMore?: boolean;
total?: number;
values: string[];
[key: string]: unknown;
};
[key: string]: unknown;
},
>

`Optional`_meta?: {
"io.modelcontextprotocol/related-task"?: { taskId: string };
progressToken?: string | number;
[key: string]: unknown;
}

`Optional`io.modelcontextprotocol/related-task?: { taskId: string }

`Optional`progressToken?: string | number

`Optional`arguments?: { [key: string]: string }

`Optional`prompts?: { listChanged?: boolean }

`Optional`listChanged?: boolean

`Optional`resources?: { listChanged?: boolean; subscribe?: boolean }

`Optional`listChanged?: boolean

`Optional`subscribe?: boolean

`Optional`requests?: {
tools?: {
call?: {
[key: string]: (...) | (...) | (...) | (...) | (...) | (...) | (...);
};
[key: string]: unknown;
};
[key: string]: unknown;
}

`Optional`tools?: {
call?: {
[key: string]: (...) | (...) | (...) | (...) | (...) | (...) | (...);
};
[key: string]: unknown;
}

`Optional`tools?: { listChanged?: boolean }

`Optional`listChanged?: boolean

Returns
| {
description?: string;
icons?: {
mimeType?: string;
sizes?: string[];
src: string;
theme?: "light"
| "dark";
}[];
name: string;
title?: string;
version: string;
websiteUrl?: string;
}
| undefined

`Optional`description?: string

`Optional`icons?: { mimeType?: string; sizes?: string[]; src: string; theme?: "light" | "dark" }[]

`Optional`title?: string

`Optional`websiteUrl?: string

`Optional`_meta?: {
"io.modelcontextprotocol/related-task"?: { taskId: string };
progressToken?: string | number;
[key: string]: unknown;
}

`Optional`io.modelcontextprotocol/related-task?: { taskId: string }

`Optional`progressToken?: string | number

`Optional`cursor?: string

`Optional`_meta?: {
"io.modelcontextprotocol/related-task"?: { taskId: string };
progressToken?: string | number;
[key: string]: unknown;
}

`Optional`io.modelcontextprotocol/related-task?: { taskId: string }

`Optional`progressToken?: string | number

`Optional`cursor?: string

`Optional`_meta?: {
"io.modelcontextprotocol/related-task"?: { taskId: string };
progressToken?: string | number;
[key: string]: unknown;
}

`Optional`io.modelcontextprotocol/related-task?: { taskId: string }

`Optional`progressToken?: string | number

`Optional`cursor?: string