@modelcontextprotocol/sdk
Version:
Model Context Protocol implementation for TypeScript
1,230 lines • 81.6 kB
JavaScript
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ProgressNotificationParamsSchema = exports.ProgressSchema = exports.PingRequestSchema = exports.isInitializedNotification = exports.InitializedNotificationSchema = exports.InitializeResultSchema = exports.ServerCapabilitiesSchema = exports.isInitializeRequest = exports.InitializeRequestSchema = exports.InitializeRequestParamsSchema = exports.ClientCapabilitiesSchema = exports.ServerTasksCapabilitySchema = exports.ClientTasksCapabilitySchema = exports.ImplementationSchema = exports.BaseMetadataSchema = exports.IconsSchema = exports.IconSchema = exports.CancelledNotificationSchema = exports.CancelledNotificationParamsSchema = exports.EmptyResultSchema = exports.JSONRPCResponseSchema = exports.JSONRPCMessageSchema = exports.isJSONRPCError = exports.isJSONRPCErrorResponse = exports.JSONRPCErrorSchema = exports.JSONRPCErrorResponseSchema = exports.ErrorCode = exports.isJSONRPCResponse = exports.isJSONRPCResultResponse = exports.JSONRPCResultResponseSchema = exports.isJSONRPCNotification = exports.JSONRPCNotificationSchema = exports.isJSONRPCRequest = exports.JSONRPCRequestSchema = exports.RequestIdSchema = exports.ResultSchema = exports.NotificationSchema = exports.RequestSchema = exports.isTaskAugmentedRequestParams = exports.TaskAugmentedRequestParamsSchema = exports.RelatedTaskMetadataSchema = exports.TaskMetadataSchema = exports.TaskCreationParamsSchema = exports.CursorSchema = exports.ProgressTokenSchema = exports.JSONRPC_VERSION = exports.RELATED_TASK_META_KEY = exports.SUPPORTED_PROTOCOL_VERSIONS = exports.DEFAULT_NEGOTIATED_PROTOCOL_VERSION = exports.LATEST_PROTOCOL_VERSION = void 0;
exports.EmbeddedResourceSchema = exports.ToolUseContentSchema = exports.AudioContentSchema = exports.ImageContentSchema = exports.TextContentSchema = exports.GetPromptRequestSchema = exports.GetPromptRequestParamsSchema = exports.ListPromptsResultSchema = exports.ListPromptsRequestSchema = exports.PromptSchema = exports.PromptArgumentSchema = exports.ResourceUpdatedNotificationSchema = exports.ResourceUpdatedNotificationParamsSchema = exports.UnsubscribeRequestSchema = exports.UnsubscribeRequestParamsSchema = exports.SubscribeRequestSchema = exports.SubscribeRequestParamsSchema = exports.ResourceListChangedNotificationSchema = exports.ReadResourceResultSchema = exports.ReadResourceRequestSchema = exports.ReadResourceRequestParamsSchema = exports.ResourceRequestParamsSchema = exports.ListResourceTemplatesResultSchema = exports.ListResourceTemplatesRequestSchema = exports.ListResourcesResultSchema = exports.ListResourcesRequestSchema = exports.ResourceTemplateSchema = exports.ResourceSchema = exports.AnnotationsSchema = exports.RoleSchema = exports.BlobResourceContentsSchema = exports.TextResourceContentsSchema = exports.ResourceContentsSchema = exports.CancelTaskResultSchema = exports.CancelTaskRequestSchema = exports.ListTasksResultSchema = exports.ListTasksRequestSchema = exports.GetTaskPayloadResultSchema = exports.GetTaskPayloadRequestSchema = exports.GetTaskResultSchema = exports.GetTaskRequestSchema = exports.TaskStatusNotificationSchema = exports.TaskStatusNotificationParamsSchema = exports.CreateTaskResultSchema = exports.TaskSchema = exports.TaskStatusSchema = exports.PaginatedResultSchema = exports.PaginatedRequestSchema = exports.PaginatedRequestParamsSchema = exports.ProgressNotificationSchema = void 0;
exports.ElicitationCompleteNotificationSchema = exports.ElicitationCompleteNotificationParamsSchema = exports.ElicitRequestSchema = exports.ElicitRequestParamsSchema = exports.ElicitRequestURLParamsSchema = exports.ElicitRequestFormParamsSchema = exports.PrimitiveSchemaDefinitionSchema = exports.EnumSchemaSchema = exports.MultiSelectEnumSchemaSchema = exports.TitledMultiSelectEnumSchemaSchema = exports.UntitledMultiSelectEnumSchemaSchema = exports.SingleSelectEnumSchemaSchema = exports.LegacyTitledEnumSchemaSchema = exports.TitledSingleSelectEnumSchemaSchema = exports.UntitledSingleSelectEnumSchemaSchema = exports.NumberSchemaSchema = exports.StringSchemaSchema = exports.BooleanSchemaSchema = exports.CreateMessageResultWithToolsSchema = exports.CreateMessageResultSchema = exports.CreateMessageRequestSchema = exports.CreateMessageRequestParamsSchema = exports.SamplingMessageSchema = exports.SamplingMessageContentBlockSchema = exports.SamplingContentSchema = exports.ToolResultContentSchema = exports.ToolChoiceSchema = exports.ModelPreferencesSchema = exports.ModelHintSchema = exports.LoggingMessageNotificationSchema = exports.LoggingMessageNotificationParamsSchema = exports.SetLevelRequestSchema = exports.SetLevelRequestParamsSchema = exports.LoggingLevelSchema = exports.ListChangedOptionsBaseSchema = exports.ToolListChangedNotificationSchema = exports.CallToolRequestSchema = exports.CallToolRequestParamsSchema = exports.CompatibilityCallToolResultSchema = exports.CallToolResultSchema = exports.ListToolsResultSchema = exports.ListToolsRequestSchema = exports.ToolSchema = exports.ToolExecutionSchema = exports.ToolAnnotationsSchema = exports.PromptListChangedNotificationSchema = exports.GetPromptResultSchema = exports.PromptMessageSchema = exports.ContentBlockSchema = exports.ResourceLinkSchema = void 0;
exports.UrlElicitationRequiredError = exports.McpError = exports.ServerResultSchema = exports.ServerNotificationSchema = exports.ServerRequestSchema = exports.ClientResultSchema = exports.ClientNotificationSchema = exports.ClientRequestSchema = exports.RootsListChangedNotificationSchema = exports.ListRootsResultSchema = exports.ListRootsRequestSchema = exports.RootSchema = exports.CompleteResultSchema = exports.CompleteRequestSchema = exports.CompleteRequestParamsSchema = exports.PromptReferenceSchema = exports.ResourceReferenceSchema = exports.ResourceTemplateReferenceSchema = exports.ElicitResultSchema = void 0;
exports.assertCompleteRequestPrompt = assertCompleteRequestPrompt;
exports.assertCompleteRequestResourceTemplate = assertCompleteRequestResourceTemplate;
const z = __importStar(require("zod/v4"));
exports.LATEST_PROTOCOL_VERSION = '2025-11-25';
exports.DEFAULT_NEGOTIATED_PROTOCOL_VERSION = '2025-03-26';
exports.SUPPORTED_PROTOCOL_VERSIONS = [exports.LATEST_PROTOCOL_VERSION, '2025-06-18', '2025-03-26', '2024-11-05', '2024-10-07'];
exports.RELATED_TASK_META_KEY = 'io.modelcontextprotocol/related-task';
/* JSON-RPC types */
exports.JSONRPC_VERSION = '2.0';
/**
* Assert 'object' type schema.
*
* @internal
*/
const AssertObjectSchema = z.custom((v) => v !== null && (typeof v === 'object' || typeof v === 'function'));
/**
* A progress token, used to associate progress notifications with the original request.
*/
exports.ProgressTokenSchema = z.union([z.string(), z.number().int()]);
/**
* An opaque token used to represent a cursor for pagination.
*/
exports.CursorSchema = z.string();
/**
* Task creation parameters, used to ask that the server create a task to represent a request.
*/
exports.TaskCreationParamsSchema = z.looseObject({
/**
* Time in milliseconds to keep task results available after completion.
* If null, the task has unlimited lifetime until manually cleaned up.
*/
ttl: z.union([z.number(), z.null()]).optional(),
/**
* Time in milliseconds to wait between task status requests.
*/
pollInterval: z.number().optional()
});
exports.TaskMetadataSchema = z.object({
ttl: z.number().optional()
});
/**
* Metadata for associating messages with a task.
* Include this in the `_meta` field under the key `io.modelcontextprotocol/related-task`.
*/
exports.RelatedTaskMetadataSchema = z.object({
taskId: z.string()
});
const RequestMetaSchema = z.looseObject({
/**
* 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.
*/
progressToken: exports.ProgressTokenSchema.optional(),
/**
* If specified, this request is related to the provided task.
*/
[exports.RELATED_TASK_META_KEY]: exports.RelatedTaskMetadataSchema.optional()
});
/**
* Common params for any request.
*/
const BaseRequestParamsSchema = z.object({
/**
* See [General fields: `_meta`](/specification/draft/basic/index#meta) for notes on `_meta` usage.
*/
_meta: RequestMetaSchema.optional()
});
/**
* Common params for any task-augmented request.
*/
exports.TaskAugmentedRequestParamsSchema = BaseRequestParamsSchema.extend({
/**
* 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.
*/
task: exports.TaskMetadataSchema.optional()
});
/**
* Checks if a value is a valid TaskAugmentedRequestParams.
* @param value - The value to check.
*
* @returns True if the value is a valid TaskAugmentedRequestParams, false otherwise.
*/
const isTaskAugmentedRequestParams = (value) => exports.TaskAugmentedRequestParamsSchema.safeParse(value).success;
exports.isTaskAugmentedRequestParams = isTaskAugmentedRequestParams;
exports.RequestSchema = z.object({
method: z.string(),
params: BaseRequestParamsSchema.loose().optional()
});
const NotificationsParamsSchema = z.object({
/**
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
* for notes on _meta usage.
*/
_meta: RequestMetaSchema.optional()
});
exports.NotificationSchema = z.object({
method: z.string(),
params: NotificationsParamsSchema.loose().optional()
});
exports.ResultSchema = z.looseObject({
/**
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
* for notes on _meta usage.
*/
_meta: RequestMetaSchema.optional()
});
/**
* A uniquely identifying ID for a request in JSON-RPC.
*/
exports.RequestIdSchema = z.union([z.string(), z.number().int()]);
/**
* A request that expects a response.
*/
exports.JSONRPCRequestSchema = z
.object({
jsonrpc: z.literal(exports.JSONRPC_VERSION),
id: exports.RequestIdSchema,
...exports.RequestSchema.shape
})
.strict();
const isJSONRPCRequest = (value) => exports.JSONRPCRequestSchema.safeParse(value).success;
exports.isJSONRPCRequest = isJSONRPCRequest;
/**
* A notification which does not expect a response.
*/
exports.JSONRPCNotificationSchema = z
.object({
jsonrpc: z.literal(exports.JSONRPC_VERSION),
...exports.NotificationSchema.shape
})
.strict();
const isJSONRPCNotification = (value) => exports.JSONRPCNotificationSchema.safeParse(value).success;
exports.isJSONRPCNotification = isJSONRPCNotification;
/**
* A successful (non-error) response to a request.
*/
exports.JSONRPCResultResponseSchema = z
.object({
jsonrpc: z.literal(exports.JSONRPC_VERSION),
id: exports.RequestIdSchema,
result: exports.ResultSchema
})
.strict();
/**
* Checks if a value is a valid JSONRPCResultResponse.
* @param value - The value to check.
*
* @returns True if the value is a valid JSONRPCResultResponse, false otherwise.
*/
const isJSONRPCResultResponse = (value) => exports.JSONRPCResultResponseSchema.safeParse(value).success;
exports.isJSONRPCResultResponse = isJSONRPCResultResponse;
/**
* @deprecated Use {@link isJSONRPCResultResponse} instead.
*
* Please note that {@link JSONRPCResponse} is a union of {@link JSONRPCResultResponse} and {@link JSONRPCErrorResponse} as per the updated JSON-RPC specification. (was previously just {@link JSONRPCResultResponse})
*/
exports.isJSONRPCResponse = exports.isJSONRPCResultResponse;
/**
* Error codes defined by the JSON-RPC specification.
*/
var ErrorCode;
(function (ErrorCode) {
// SDK error codes
ErrorCode[ErrorCode["ConnectionClosed"] = -32000] = "ConnectionClosed";
ErrorCode[ErrorCode["RequestTimeout"] = -32001] = "RequestTimeout";
// Standard JSON-RPC error codes
ErrorCode[ErrorCode["ParseError"] = -32700] = "ParseError";
ErrorCode[ErrorCode["InvalidRequest"] = -32600] = "InvalidRequest";
ErrorCode[ErrorCode["MethodNotFound"] = -32601] = "MethodNotFound";
ErrorCode[ErrorCode["InvalidParams"] = -32602] = "InvalidParams";
ErrorCode[ErrorCode["InternalError"] = -32603] = "InternalError";
// MCP-specific error codes
ErrorCode[ErrorCode["UrlElicitationRequired"] = -32042] = "UrlElicitationRequired";
})(ErrorCode || (exports.ErrorCode = ErrorCode = {}));
/**
* A response to a request that indicates an error occurred.
*/
exports.JSONRPCErrorResponseSchema = z
.object({
jsonrpc: z.literal(exports.JSONRPC_VERSION),
id: exports.RequestIdSchema.optional(),
error: z.object({
/**
* The error type that occurred.
*/
code: z.number().int(),
/**
* A short description of the error. The message SHOULD be limited to a concise single sentence.
*/
message: z.string(),
/**
* Additional information about the error. The value of this member is defined by the sender (e.g. detailed error information, nested errors etc.).
*/
data: z.unknown().optional()
})
})
.strict();
/**
* @deprecated Use {@link JSONRPCErrorResponseSchema} instead.
*/
exports.JSONRPCErrorSchema = exports.JSONRPCErrorResponseSchema;
/**
* Checks if a value is a valid JSONRPCErrorResponse.
* @param value - The value to check.
*
* @returns True if the value is a valid JSONRPCErrorResponse, false otherwise.
*/
const isJSONRPCErrorResponse = (value) => exports.JSONRPCErrorResponseSchema.safeParse(value).success;
exports.isJSONRPCErrorResponse = isJSONRPCErrorResponse;
/**
* @deprecated Use {@link isJSONRPCErrorResponse} instead.
*/
exports.isJSONRPCError = exports.isJSONRPCErrorResponse;
exports.JSONRPCMessageSchema = z.union([
exports.JSONRPCRequestSchema,
exports.JSONRPCNotificationSchema,
exports.JSONRPCResultResponseSchema,
exports.JSONRPCErrorResponseSchema
]);
exports.JSONRPCResponseSchema = z.union([exports.JSONRPCResultResponseSchema, exports.JSONRPCErrorResponseSchema]);
/* Empty result */
/**
* A response that indicates success but carries no data.
*/
exports.EmptyResultSchema = exports.ResultSchema.strict();
exports.CancelledNotificationParamsSchema = NotificationsParamsSchema.extend({
/**
* The ID of the request to cancel.
*
* This MUST correspond to the ID of a request previously issued in the same direction.
*/
requestId: exports.RequestIdSchema.optional(),
/**
* An optional string describing the reason for the cancellation. This MAY be logged or presented to the user.
*/
reason: z.string().optional()
});
/* Cancellation */
/**
* This notification can be sent by either side to indicate that it is cancelling a previously-issued request.
*
* The request SHOULD still be in-flight, but due to communication latency, it is always possible that this notification MAY arrive after the request has already finished.
*
* This notification indicates that the result will be unused, so any associated processing SHOULD cease.
*
* A client MUST NOT attempt to cancel its `initialize` request.
*/
exports.CancelledNotificationSchema = exports.NotificationSchema.extend({
method: z.literal('notifications/cancelled'),
params: exports.CancelledNotificationParamsSchema
});
/* Base Metadata */
/**
* Icon schema for use in tools, prompts, resources, and implementations.
*/
exports.IconSchema = z.object({
/**
* URL or data URI for the icon.
*/
src: z.string(),
/**
* Optional MIME type for the icon.
*/
mimeType: z.string().optional(),
/**
* Optional array of strings that specify sizes at which the icon can be used.
* Each string should be in WxH format (e.g., `"48x48"`, `"96x96"`) or `"any"` for scalable formats like SVG.
*
* If not provided, the client should assume that the icon can be used at any size.
*/
sizes: z.array(z.string()).optional(),
/**
* Optional specifier for the theme this icon is designed for. `light` indicates
* the icon is designed to be used with a light background, and `dark` indicates
* the icon is designed to be used with a dark background.
*
* If not provided, the client should assume the icon can be used with any theme.
*/
theme: z.enum(['light', 'dark']).optional()
});
/**
* Base schema to add `icons` property.
*
*/
exports.IconsSchema = z.object({
/**
* 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)
*/
icons: z.array(exports.IconSchema).optional()
});
/**
* Base metadata interface for common properties across resources, tools, prompts, and implementations.
*/
exports.BaseMetadataSchema = z.object({
/** Intended for programmatic or logical use, but used as a display name in past specs or fallback */
name: z.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).
*/
title: z.string().optional()
});
/* Initialization */
/**
* Describes the name and version of an MCP implementation.
*/
exports.ImplementationSchema = exports.BaseMetadataSchema.extend({
...exports.BaseMetadataSchema.shape,
...exports.IconsSchema.shape,
version: z.string(),
/**
* An optional URL of the website for this implementation.
*/
websiteUrl: z.string().optional(),
/**
* 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.
*/
description: z.string().optional()
});
const FormElicitationCapabilitySchema = z.intersection(z.object({
applyDefaults: z.boolean().optional()
}), z.record(z.string(), z.unknown()));
const ElicitationCapabilitySchema = z.preprocess(value => {
if (value && typeof value === 'object' && !Array.isArray(value)) {
if (Object.keys(value).length === 0) {
return { form: {} };
}
}
return value;
}, z.intersection(z.object({
form: FormElicitationCapabilitySchema.optional(),
url: AssertObjectSchema.optional()
}), z.record(z.string(), z.unknown()).optional()));
/**
* Task capabilities for clients, indicating which request types support task creation.
*/
exports.ClientTasksCapabilitySchema = z.looseObject({
/**
* Present if the client supports listing tasks.
*/
list: AssertObjectSchema.optional(),
/**
* Present if the client supports cancelling tasks.
*/
cancel: AssertObjectSchema.optional(),
/**
* Capabilities for task creation on specific request types.
*/
requests: z
.looseObject({
/**
* Task support for sampling requests.
*/
sampling: z
.looseObject({
createMessage: AssertObjectSchema.optional()
})
.optional(),
/**
* Task support for elicitation requests.
*/
elicitation: z
.looseObject({
create: AssertObjectSchema.optional()
})
.optional()
})
.optional()
});
/**
* Task capabilities for servers, indicating which request types support task creation.
*/
exports.ServerTasksCapabilitySchema = z.looseObject({
/**
* Present if the server supports listing tasks.
*/
list: AssertObjectSchema.optional(),
/**
* Present if the server supports cancelling tasks.
*/
cancel: AssertObjectSchema.optional(),
/**
* Capabilities for task creation on specific request types.
*/
requests: z
.looseObject({
/**
* Task support for tool requests.
*/
tools: z
.looseObject({
call: AssertObjectSchema.optional()
})
.optional()
})
.optional()
});
/**
* Capabilities a client may support. Known capabilities are defined here, in this schema, but this is not a closed set: any client can define its own, additional capabilities.
*/
exports.ClientCapabilitiesSchema = z.object({
/**
* Experimental, non-standard capabilities that the client supports.
*/
experimental: z.record(z.string(), AssertObjectSchema).optional(),
/**
* Present if the client supports sampling from an LLM.
*/
sampling: z
.object({
/**
* Present if the client supports context inclusion via includeContext parameter.
* If not declared, servers SHOULD only use `includeContext: "none"` (or omit it).
*/
context: AssertObjectSchema.optional(),
/**
* Present if the client supports tool use via tools and toolChoice parameters.
*/
tools: AssertObjectSchema.optional()
})
.optional(),
/**
* Present if the client supports eliciting user input.
*/
elicitation: ElicitationCapabilitySchema.optional(),
/**
* Present if the client supports listing roots.
*/
roots: z
.object({
/**
* Whether the client supports issuing notifications for changes to the roots list.
*/
listChanged: z.boolean().optional()
})
.optional(),
/**
* Present if the client supports task creation.
*/
tasks: exports.ClientTasksCapabilitySchema.optional()
});
exports.InitializeRequestParamsSchema = BaseRequestParamsSchema.extend({
/**
* The latest version of the Model Context Protocol that the client supports. The client MAY decide to support older versions as well.
*/
protocolVersion: z.string(),
capabilities: exports.ClientCapabilitiesSchema,
clientInfo: exports.ImplementationSchema
});
/**
* This request is sent from the client to the server when it first connects, asking it to begin initialization.
*/
exports.InitializeRequestSchema = exports.RequestSchema.extend({
method: z.literal('initialize'),
params: exports.InitializeRequestParamsSchema
});
const isInitializeRequest = (value) => exports.InitializeRequestSchema.safeParse(value).success;
exports.isInitializeRequest = isInitializeRequest;
/**
* Capabilities that a server may support. Known capabilities are defined here, in this schema, but this is not a closed set: any server can define its own, additional capabilities.
*/
exports.ServerCapabilitiesSchema = z.object({
/**
* Experimental, non-standard capabilities that the server supports.
*/
experimental: z.record(z.string(), AssertObjectSchema).optional(),
/**
* Present if the server supports sending log messages to the client.
*/
logging: AssertObjectSchema.optional(),
/**
* Present if the server supports sending completions to the client.
*/
completions: AssertObjectSchema.optional(),
/**
* Present if the server offers any prompt templates.
*/
prompts: z
.object({
/**
* Whether this server supports issuing notifications for changes to the prompt list.
*/
listChanged: z.boolean().optional()
})
.optional(),
/**
* Present if the server offers any resources to read.
*/
resources: z
.object({
/**
* Whether this server supports clients subscribing to resource updates.
*/
subscribe: z.boolean().optional(),
/**
* Whether this server supports issuing notifications for changes to the resource list.
*/
listChanged: z.boolean().optional()
})
.optional(),
/**
* Present if the server offers any tools to call.
*/
tools: z
.object({
/**
* Whether this server supports issuing notifications for changes to the tool list.
*/
listChanged: z.boolean().optional()
})
.optional(),
/**
* Present if the server supports task creation.
*/
tasks: exports.ServerTasksCapabilitySchema.optional()
});
/**
* After receiving an initialize request from the client, the server sends this response.
*/
exports.InitializeResultSchema = exports.ResultSchema.extend({
/**
* The version of the Model Context Protocol that the server wants to use. This may not match the version that the client requested. If the client cannot support this version, it MUST disconnect.
*/
protocolVersion: z.string(),
capabilities: exports.ServerCapabilitiesSchema,
serverInfo: exports.ImplementationSchema,
/**
* Instructions describing how to use the server and its features.
*
* This can be used by clients to improve the LLM's understanding of available tools, resources, etc. It can be thought of like a "hint" to the model. For example, this information MAY be added to the system prompt.
*/
instructions: z.string().optional()
});
/**
* This notification is sent from the client to the server after initialization has finished.
*/
exports.InitializedNotificationSchema = exports.NotificationSchema.extend({
method: z.literal('notifications/initialized'),
params: NotificationsParamsSchema.optional()
});
const isInitializedNotification = (value) => exports.InitializedNotificationSchema.safeParse(value).success;
exports.isInitializedNotification = isInitializedNotification;
/* Ping */
/**
* A ping, issued by either the server or the client, to check that the other party is still alive. The receiver must promptly respond, or else may be disconnected.
*/
exports.PingRequestSchema = exports.RequestSchema.extend({
method: z.literal('ping'),
params: BaseRequestParamsSchema.optional()
});
/* Progress notifications */
exports.ProgressSchema = z.object({
/**
* The progress thus far. This should increase every time progress is made, even if the total is unknown.
*/
progress: z.number(),
/**
* Total number of items to process (or total progress required), if known.
*/
total: z.optional(z.number()),
/**
* An optional message describing the current progress.
*/
message: z.optional(z.string())
});
exports.ProgressNotificationParamsSchema = z.object({
...NotificationsParamsSchema.shape,
...exports.ProgressSchema.shape,
/**
* The progress token which was given in the initial request, used to associate this notification with the request that is proceeding.
*/
progressToken: exports.ProgressTokenSchema
});
/**
* An out-of-band notification used to inform the receiver of a progress update for a long-running request.
*
* @category notifications/progress
*/
exports.ProgressNotificationSchema = exports.NotificationSchema.extend({
method: z.literal('notifications/progress'),
params: exports.ProgressNotificationParamsSchema
});
exports.PaginatedRequestParamsSchema = BaseRequestParamsSchema.extend({
/**
* An opaque token representing the current pagination position.
* If provided, the server should return results starting after this cursor.
*/
cursor: exports.CursorSchema.optional()
});
/* Pagination */
exports.PaginatedRequestSchema = exports.RequestSchema.extend({
params: exports.PaginatedRequestParamsSchema.optional()
});
exports.PaginatedResultSchema = exports.ResultSchema.extend({
/**
* An opaque token representing the pagination position after the last returned result.
* If present, there may be more results available.
*/
nextCursor: exports.CursorSchema.optional()
});
/**
* The status of a task.
* */
exports.TaskStatusSchema = z.enum(['working', 'input_required', 'completed', 'failed', 'cancelled']);
/* Tasks */
/**
* A pollable state object associated with a request.
*/
exports.TaskSchema = z.object({
taskId: z.string(),
status: exports.TaskStatusSchema,
/**
* Time in milliseconds to keep task results available after completion.
* If null, the task has unlimited lifetime until manually cleaned up.
*/
ttl: z.union([z.number(), z.null()]),
/**
* ISO 8601 timestamp when the task was created.
*/
createdAt: z.string(),
/**
* ISO 8601 timestamp when the task was last updated.
*/
lastUpdatedAt: z.string(),
pollInterval: z.optional(z.number()),
/**
* Optional diagnostic message for failed tasks or other status information.
*/
statusMessage: z.optional(z.string())
});
/**
* Result returned when a task is created, containing the task data wrapped in a task field.
*/
exports.CreateTaskResultSchema = exports.ResultSchema.extend({
task: exports.TaskSchema
});
/**
* Parameters for task status notification.
*/
exports.TaskStatusNotificationParamsSchema = NotificationsParamsSchema.merge(exports.TaskSchema);
/**
* A notification sent when a task's status changes.
*/
exports.TaskStatusNotificationSchema = exports.NotificationSchema.extend({
method: z.literal('notifications/tasks/status'),
params: exports.TaskStatusNotificationParamsSchema
});
/**
* A request to get the state of a specific task.
*/
exports.GetTaskRequestSchema = exports.RequestSchema.extend({
method: z.literal('tasks/get'),
params: BaseRequestParamsSchema.extend({
taskId: z.string()
})
});
/**
* The response to a tasks/get request.
*/
exports.GetTaskResultSchema = exports.ResultSchema.merge(exports.TaskSchema);
/**
* A request to get the result of a specific task.
*/
exports.GetTaskPayloadRequestSchema = exports.RequestSchema.extend({
method: z.literal('tasks/result'),
params: BaseRequestParamsSchema.extend({
taskId: z.string()
})
});
/**
* The response to a tasks/result request.
* The structure matches the result type of the original request.
* For example, a tools/call task would return the CallToolResult structure.
*
*/
exports.GetTaskPayloadResultSchema = exports.ResultSchema.loose();
/**
* A request to list tasks.
*/
exports.ListTasksRequestSchema = exports.PaginatedRequestSchema.extend({
method: z.literal('tasks/list')
});
/**
* The response to a tasks/list request.
*/
exports.ListTasksResultSchema = exports.PaginatedResultSchema.extend({
tasks: z.array(exports.TaskSchema)
});
/**
* A request to cancel a specific task.
*/
exports.CancelTaskRequestSchema = exports.RequestSchema.extend({
method: z.literal('tasks/cancel'),
params: BaseRequestParamsSchema.extend({
taskId: z.string()
})
});
/**
* The response to a tasks/cancel request.
*/
exports.CancelTaskResultSchema = exports.ResultSchema.merge(exports.TaskSchema);
/* Resources */
/**
* The contents of a specific resource or sub-resource.
*/
exports.ResourceContentsSchema = z.object({
/**
* The URI of this resource.
*/
uri: z.string(),
/**
* The MIME type of this resource, if known.
*/
mimeType: z.optional(z.string()),
/**
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
* for notes on _meta usage.
*/
_meta: z.record(z.string(), z.unknown()).optional()
});
exports.TextResourceContentsSchema = exports.ResourceContentsSchema.extend({
/**
* The text of the item. This must only be set if the item can actually be represented as text (not binary data).
*/
text: z.string()
});
/**
* A Zod schema for validating Base64 strings that is more performant and
* robust for very large inputs than the default regex-based check. It avoids
* stack overflows by using the native `atob` function for validation.
*/
const Base64Schema = z.string().refine(val => {
try {
// atob throws a DOMException if the string contains characters
// that are not part of the Base64 character set.
atob(val);
return true;
}
catch {
return false;
}
}, { message: 'Invalid Base64 string' });
exports.BlobResourceContentsSchema = exports.ResourceContentsSchema.extend({
/**
* A base64-encoded string representing the binary data of the item.
*/
blob: Base64Schema
});
/**
* The sender or recipient of messages and data in a conversation.
*/
exports.RoleSchema = z.enum(['user', 'assistant']);
/**
* Optional annotations providing clients additional context about a resource.
*/
exports.AnnotationsSchema = z.object({
/**
* Intended audience(s) for the resource.
*/
audience: z.array(exports.RoleSchema).optional(),
/**
* Importance hint for the resource, from 0 (least) to 1 (most).
*/
priority: z.number().min(0).max(1).optional(),
/**
* ISO 8601 timestamp for the most recent modification.
*/
lastModified: z.iso.datetime({ offset: true }).optional()
});
/**
* A known resource that the server is capable of reading.
*/
exports.ResourceSchema = z.object({
...exports.BaseMetadataSchema.shape,
...exports.IconsSchema.shape,
/**
* The URI of this resource.
*/
uri: z.string(),
/**
* A description of what this resource represents.
*
* This can be used by clients to improve the LLM's understanding of available resources. It can be thought of like a "hint" to the model.
*/
description: z.optional(z.string()),
/**
* The MIME type of this resource, if known.
*/
mimeType: z.optional(z.string()),
/**
* Optional annotations for the client.
*/
annotations: exports.AnnotationsSchema.optional(),
/**
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
* for notes on _meta usage.
*/
_meta: z.optional(z.looseObject({}))
});
/**
* A template description for resources available on the server.
*/
exports.ResourceTemplateSchema = z.object({
...exports.BaseMetadataSchema.shape,
...exports.IconsSchema.shape,
/**
* A URI template (according to RFC 6570) that can be used to construct resource URIs.
*/
uriTemplate: z.string(),
/**
* A description of what this template is for.
*
* This can be used by clients to improve the LLM's understanding of available resources. It can be thought of like a "hint" to the model.
*/
description: z.optional(z.string()),
/**
* The MIME type for all resources that match this template. This should only be included if all resources matching this template have the same type.
*/
mimeType: z.optional(z.string()),
/**
* Optional annotations for the client.
*/
annotations: exports.AnnotationsSchema.optional(),
/**
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
* for notes on _meta usage.
*/
_meta: z.optional(z.looseObject({}))
});
/**
* Sent from the client to request a list of resources the server has.
*/
exports.ListResourcesRequestSchema = exports.PaginatedRequestSchema.extend({
method: z.literal('resources/list')
});
/**
* The server's response to a resources/list request from the client.
*/
exports.ListResourcesResultSchema = exports.PaginatedResultSchema.extend({
resources: z.array(exports.ResourceSchema)
});
/**
* Sent from the client to request a list of resource templates the server has.
*/
exports.ListResourceTemplatesRequestSchema = exports.PaginatedRequestSchema.extend({
method: z.literal('resources/templates/list')
});
/**
* The server's response to a resources/templates/list request from the client.
*/
exports.ListResourceTemplatesResultSchema = exports.PaginatedResultSchema.extend({
resourceTemplates: z.array(exports.ResourceTemplateSchema)
});
exports.ResourceRequestParamsSchema = BaseRequestParamsSchema.extend({
/**
* 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
*/
uri: z.string()
});
/**
* Parameters for a `resources/read` request.
*/
exports.ReadResourceRequestParamsSchema = exports.ResourceRequestParamsSchema;
/**
* Sent from the client to the server, to read a specific resource URI.
*/
exports.ReadResourceRequestSchema = exports.RequestSchema.extend({
method: z.literal('resources/read'),
params: exports.ReadResourceRequestParamsSchema
});
/**
* The server's response to a resources/read request from the client.
*/
exports.ReadResourceResultSchema = exports.ResultSchema.extend({
contents: z.array(z.union([exports.TextResourceContentsSchema, exports.BlobResourceContentsSchema]))
});
/**
* An optional notification from the server to the client, informing it that the list of resources it can read from has changed. This may be issued by servers without any previous subscription from the client.
*/
exports.ResourceListChangedNotificationSchema = exports.NotificationSchema.extend({
method: z.literal('notifications/resources/list_changed'),
params: NotificationsParamsSchema.optional()
});
exports.SubscribeRequestParamsSchema = exports.ResourceRequestParamsSchema;
/**
* Sent from the client to request resources/updated notifications from the server whenever a particular resource changes.
*/
exports.SubscribeRequestSchema = exports.RequestSchema.extend({
method: z.literal('resources/subscribe'),
params: exports.SubscribeRequestParamsSchema
});
exports.UnsubscribeRequestParamsSchema = exports.ResourceRequestParamsSchema;
/**
* Sent from the client to request cancellation of resources/updated notifications from the server. This should follow a previous resources/subscribe request.
*/
exports.UnsubscribeRequestSchema = exports.RequestSchema.extend({
method: z.literal('resources/unsubscribe'),
params: exports.UnsubscribeRequestParamsSchema
});
/**
* Parameters for a `notifications/resources/updated` notification.
*/
exports.ResourceUpdatedNotificationParamsSchema = NotificationsParamsSchema.extend({
/**
* The URI of the resource that has been updated. This might be a sub-resource of the one that the client actually subscribed to.
*/
uri: z.string()
});
/**
* A notification from the server to the client, informing it that a resource has changed and may need to be read again. This should only be sent if the client previously sent a resources/subscribe request.
*/
exports.ResourceUpdatedNotificationSchema = exports.NotificationSchema.extend({
method: z.literal('notifications/resources/updated'),
params: exports.ResourceUpdatedNotificationParamsSchema
});
/* Prompts */
/**
* Describes an argument that a prompt can accept.
*/
exports.PromptArgumentSchema = z.object({
/**
* The name of the argument.
*/
name: z.string(),
/**
* A human-readable description of the argument.
*/
description: z.optional(z.string()),
/**
* Whether this argument must be provided.
*/
required: z.optional(z.boolean())
});
/**
* A prompt or prompt template that the server offers.
*/
exports.PromptSchema = z.object({
...exports.BaseMetadataSchema.shape,
...exports.IconsSchema.shape,
/**
* An optional description of what this prompt provides
*/
description: z.optional(z.string()),
/**
* A list of arguments to use for templating the prompt.
*/
arguments: z.optional(z.array(exports.PromptArgumentSchema)),
/**
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
* for notes on _meta usage.
*/
_meta: z.optional(z.looseObject({}))
});
/**
* Sent from the client to request a list of prompts and prompt templates the server has.
*/
exports.ListPromptsRequestSchema = exports.PaginatedRequestSchema.extend({
method: z.literal('prompts/list')
});
/**
* The server's response to a prompts/list request from the client.
*/
exports.ListPromptsResultSchema = exports.PaginatedResultSchema.extend({
prompts: z.array(exports.PromptSchema)
});
/**
* Parameters for a `prompts/get` request.
*/
exports.GetPromptRequestParamsSchema = BaseRequestParamsSchema.extend({
/**
* The name of the prompt or prompt template.
*/
name: z.string(),
/**
* Arguments to use for templating the prompt.
*/
arguments: z.record(z.string(), z.string()).optional()
});
/**
* Used by the client to get a prompt provided by the server.
*/
exports.GetPromptRequestSchema = exports.RequestSchema.extend({
method: z.literal('prompts/get'),
params: exports.GetPromptRequestParamsSchema
});
/**
* Text provided to or from an LLM.
*/
exports.TextContentSchema = z.object({
type: z.literal('text'),
/**
* The text content of the message.
*/
text: z.string(),
/**
* Optional annotations for the client.
*/
annotations: exports.AnnotationsSchema.optional(),
/**
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
* for notes on _meta usage.
*/
_meta: z.record(z.string(), z.unknown()).optional()
});
/**
* An image provided to or from an LLM.
*/
exports.ImageContentSchema = z.object({
type: z.literal('image'),
/**
* The base64-encoded image data.
*/
data: Base64Schema,
/**
* The MIME type of the image. Different providers may support different image types.
*/
mimeType: z.string(),
/**
* Optional annotations for the client.
*/
annotations: exports.AnnotationsSchema.optional(),
/**
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
* for notes on _meta usage.
*/
_meta: z.record(z.string(), z.unknown()).optional()
});
/**
* An Audio provided to or from an LLM.
*/
exports.AudioContentSchema = z.object({
type: z.literal('audio'),
/**
* The base64-encoded audio data.
*/
data: Base64Schema,
/**
* The MIME type of the audio. Different providers may support different audio types.
*/
mimeType: z.string(),
/**
* Optional annotations for the client.
*/
annotations: exports.AnnotationsSchema.optional(),
/**
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
* for notes on _meta usage.
*/
_meta: z.record(z.string(), z.unknown()).optional()
});
/**
* A tool call request from an assistant (LLM).
* Represents the assistant's request to use a tool.
*/
exports.ToolUseContentSchema = z.object({
type: z.literal('tool_use'),
/**
* The name of the tool to invoke.
* Must match a tool name from the request's tools array.
*/
name: z.string(),
/**
* Unique identifier for this tool call.
* Used to correlate with ToolResultContent in subsequent messages.
*/
id: z.string(),
/**
* Arguments to pass to the tool.
* Must conform to the tool's inputSchema.
*/
input: z.record(z.string(), z.unknown()),
/**
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
* for notes on _meta usage.
*/
_meta: z.record(z.string(), z.unknown()).optional()
});
/**
* The contents of a resource, embedded into a prompt or tool call result.
*/
exports.EmbeddedResourceSchema = z.object({
type: z.literal('resource'),
resource: z.union([exports.TextResourceContentsSchema, exports.BlobResourceContentsSchema]),
/**
* Optional annotations for the client.
*/
annotations: exports.AnnotationsSchema.optional(),
/**
* See [MCP specification](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/47339c03c143bb4ec01a26e721a1b8fe66634ebe/docs/specification/draft/basic/index.mdx#general-fields)
* for notes on _meta usage.
*/
_meta: z.record(z.string(), z.unknown()).optional()
});
/**
* A resource that the server is capable of reading, included in a prompt or tool call result.
*
* Note: resource links returned by tools are not guaranteed to appear in the results of `resources/list` requests.
*/
exports.ResourceLinkSchema = exports.ResourceSchema.extend({
type: z.literal('resource_link')
});
/**
* A content block that can be used in prompts and tool results.
*/
exports.ContentBlockSchema = z.union([
exports.TextContentSchema,
exports.ImageContentSchema,
exports.AudioContentSchema,
exports.ResourceLinkSchema,
exports.EmbeddedResourceSchema
]);
/**
* Describes a message returned as part of a prompt.
*/
exports.PromptMessageSchema = z.object({
role: exports.RoleSchema,
content: exports.ContentBlockSchema
});
/**
* The server's response to a prompts/get request from the client.
*/
exports.GetPromptResultSchema = exports.ResultSchema.extend({
/**
* An optional description for the prompt.
*/
description: z.string().optional(),
messages: z.array(exports.PromptMessageSchema)
});
/**
* An optional notification from the server to the client, informing it that the list of prompts it offers has changed. This may be issued by servers without any previous subscription from the client.
*/
exports.PromptListChangedNotificationSchema = exports.NotificationSchema.extend({
method: z.literal('notifications/prompts/list_changed'),
params: NotificationsParamsSchema.optional()
});
/* Tools */
/**
* Additional properties describing a Tool to clients.
*
* NOTE: all properties in ToolAnnotations are **hints**.
* They are not guaranteed to provide a faithful description of
* tool behavior (including descriptive properties like `title`).
*
* Clients should never make tool use decisions based on ToolAnnotations
* received from untrusted servers.
*/
exports.ToolAnnotationsSchema = z.object({
/**
* A human-readable title for the tool.
*/
title: z.string().optional(),
/**
* If true, the tool does not modify its environment.
*
* Default: false
*/
readOnlyHint: z.boolean().optional(),
/**
* If true, the tool may perform destructive updates to its environment.
* If false, the tool performs only additive updates.
*
* (This property is meaningful only when `readOnlyHint == false`)
*
* Default: true
*/
destructiveHint: z.boolean().optional(),
/**
* If true, calling the tool repeatedly with the same arguments
* will have no additional effect on the its environment.
*
* (This property is meaningful only when `readOnlyHint == false`)
*
* Default: false
*/
idempotentHint: z.boolean().optional(),
/**
* If true, this tool may interact with an "open world" of external
* entities. If false, the tool's domain of interaction is closed.
* For example, the world of a web search tool i