Expand description
Types defined in the MCP protocol schema
This module was automatically generated from the MCP protocol schema.
Modules§
- error
- Error types.
Structs§
- Annotations
- Optional annotations for the client. The client can use annotations to inform how objects are used or displayed
- Audio
Content - Audio provided to or from an LLM.
- Blob
Resource Contents - BlobResourceContents
- Call
Tool Request - Used by the client to invoke a tool provided by the server.
- Call
Tool Request Params - CallToolRequestParams
- Call
Tool Result - The server’s response to a tool call.
- Cancelled
Notification - This notification can be sent by either side to indicate that it is cancelling a previously-issued request.
- Cancelled
Notification Params - CancelledNotificationParams
- Client
Capabilities - 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.
- Client
Capabilities Roots - Present if the client supports listing roots.
- Complete
Request - A request from the client to the server, to ask for completion options.
- Complete
Request Params - CompleteRequestParams
- Complete
Request Params Argument - The argument’s information
- Complete
Result - The server’s response to a completion/complete request
- Complete
Result Completion - CompleteResultCompletion
- Create
Message Request - A request from the server to sample an LLM via the client. The client has full discretion over which model to select. The client should also inform the user before beginning sampling, to allow them to inspect the request (human in the loop) and decide whether to approve it.
- Create
Message Request Params - CreateMessageRequestParams
- Create
Message Result - The client’s response to a sampling/create_message request from the server. The client should inform the user before returning the sampled message, to allow them to inspect the response (human in the loop) and decide whether to allow the server to see it.
- Cursor
- An opaque token used to represent a cursor for pagination.
- Embedded
Resource - The contents of a resource, embedded into a prompt or tool call result.
- Empty
Result - EmptyResult
- GetPrompt
Request - Used by the client to get a prompt provided by the server.
- GetPrompt
Request Params - GetPromptRequestParams
- GetPrompt
Result - The server’s response to a prompts/get request from the client.
- Image
Content - An image provided to or from an LLM.
- Implementation
- Describes the name and version of an MCP implementation.
- Initialize
Request - This request is sent from the client to the server when it first connects, asking it to begin initialization.
- Initialize
Request Params - InitializeRequestParams
- Initialize
Result - After receiving an initialize request from the client, the server sends this response.
- Initialized
Notification - This notification is sent from the client to the server after initialization has finished.
- Initialized
Notification Params - InitializedNotificationParams
- Jsonrpc
Batch Request - A JSON-RPC batch request, as described in https://www.jsonrpc.org/specification#batch.
- Jsonrpc
Batch Response - A JSON-RPC batch response, as described in https://www.jsonrpc.org/specification#batch.
- Jsonrpc
Error - A response to a request that indicates an error occurred.
- Jsonrpc
Error Error - JsonrpcErrorError
- Jsonrpc
Message - Refers to any valid JSON-RPC object that can be decoded off the wire, or encoded to be sent.
- Jsonrpc
Notification - A notification which does not expect a response.
- Jsonrpc
Notification Params - JsonrpcNotificationParams
- Jsonrpc
Request - A request that expects a response.
- Jsonrpc
Request Params - JsonrpcRequestParams
- Jsonrpc
Request Params Meta - JsonrpcRequestParamsMeta
- Jsonrpc
Response - A successful (non-error) response to a request.
- List
Prompts Request - Sent from the client to request a list of prompts and prompt templates the server has.
- List
Prompts Request Params - ListPromptsRequestParams
- List
Prompts Result - The server’s response to a prompts/list request from the client.
- List
Resource Templates Request - Sent from the client to request a list of resource templates the server has.
- List
Resource Templates Request Params - ListResourceTemplatesRequestParams
- List
Resource Templates Result - The server’s response to a resources/templates/list request from the client.
- List
Resources Request - Sent from the client to request a list of resources the server has.
- List
Resources Request Params - ListResourcesRequestParams
- List
Resources Result - The server’s response to a resources/list request from the client.
- List
Roots Request - Sent from the server to request a list of root URIs from the client. Roots allow servers to ask for specific directories or files to operate on. A common example for roots is providing a set of repositories or directories a server should operate on.
- List
Roots Request Params - ListRootsRequestParams
- List
Roots Request Params Meta - ListRootsRequestParamsMeta
- List
Roots Result - The client’s response to a roots/list request from the server. This result contains an array of Root objects, each representing a root directory or file that the server can operate on.
- List
Tools Request - Sent from the client to request a list of tools the server has.
- List
Tools Request Params - ListToolsRequestParams
- List
Tools Result - The server’s response to a tools/list request from the client.
- Logging
Message Notification - Notification of a log message passed from server to client. If no logging/setLevel request has been sent from the client, the server MAY decide which messages to send automatically.
- Logging
Message Notification Params - LoggingMessageNotificationParams
- Model
Hint - Hints to use for model selection.
- Model
Preferences - The server’s preferences for model selection, requested of the client during sampling.
- Notification
- Notification
- Notification
Params - NotificationParams
- Paginated
Request - PaginatedRequest
- Paginated
Request Params - PaginatedRequestParams
- Paginated
Result - PaginatedResult
- Ping
Request - 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.
- Ping
Request Params - PingRequestParams
- Ping
Request Params Meta - PingRequestParamsMeta
- Progress
Notification - An out-of-band notification used to inform the receiver of a progress update for a long-running request.
- Progress
Notification Params - ProgressNotificationParams
- Prompt
- A prompt or prompt template that the server offers.
- Prompt
Argument - Describes an argument that a prompt can accept.
- Prompt
List Changed Notification - 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.
- Prompt
List Changed Notification Params - PromptListChangedNotificationParams
- Prompt
Message - Describes a message returned as part of a prompt.
- Prompt
Reference - Identifies a prompt.
- Read
Resource Request - Sent from the client to the server, to read a specific resource URI.
- Read
Resource Request Params - ReadResourceRequestParams
- Read
Resource Result - The server’s response to a resources/read request from the client.
- Request
- Request
- Request
Id - Request
Params - RequestParams
- Request
Params Meta - RequestParamsMeta
- Resource
- A known resource that the server is capable of reading.
- Resource
Contents - The contents of a specific resource or sub-resource.
- Resource
List Changed Notification - 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.
- Resource
List Changed Notification Params - ResourceListChangedNotificationParams
- Resource
Reference - A reference to a resource or resource template definition.
- Resource
Template - A template description for resources available on the server.
- Resource
Updated Notification - 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.
- Resource
Updated Notification Params - ResourceUpdatedNotificationParams
- Result
- Result
- Root
- Represents a root directory or file that the server can operate on.
- Roots
List Changed Notification - A notification from the client to the server, informing it that the list of roots has changed. This notification should be sent whenever the client adds, removes, or modifies any root. The server should then request an updated list of roots using the ListRootsRequest.
- Roots
List Changed Notification Params - RootsListChangedNotificationParams
- Sampling
Message - Describes a message issued to or received from an LLM API.
- Server
Capabilities - 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.
- Server
Capabilities Prompts - Present if the server offers any prompt templates.
- Server
Capabilities Resources - Present if the server offers any resources to read.
- Server
Capabilities Tools - Present if the server offers any tools to call.
- SetLevel
Request - A request from the client to the server, to enable or adjust logging.
- SetLevel
Request Params - SetLevelRequestParams
- Subscribe
Request - Sent from the client to request resources/updated notifications from the server whenever a particular resource changes.
- Subscribe
Request Params - SubscribeRequestParams
- Text
Content - Text provided to or from an LLM.
- Text
Resource Contents - TextResourceContents
- Tool
- Definition for a tool the client can call.
- Tool
Annotations - Additional properties describing a Tool to clients.
- Tool
Input Schema - A JSON Schema object defining the expected parameters for the tool.
- Tool
List Changed Notification - An optional notification from the server to the client, informing it that the list of tools it offers has changed. This may be issued by servers without any previous subscription from the client.
- Tool
List Changed Notification Params - ToolListChangedNotificationParams
- Unsubscribe
Request - Sent from the client to request cancellation of resources/updated notifications from the server. This should follow a previous resources/subscribe request.
- Unsubscribe
Request Params - UnsubscribeRequestParams
Enums§
- Call
Tool Result Content Item - CallToolResultContentItem
- Client
Notification - ClientNotification
- Client
Request - ClientRequest
- Client
Result - ClientResult
- Complete
Request Params Ref - CompleteRequestParamsRef
- Create
Message Request Params Include Context - A request to include context from one or more MCP servers (including the caller), to be attached to the prompt. The client MAY ignore this request.
- Create
Message Result Content - CreateMessageResultContent
- Embedded
Resource Resource - EmbeddedResourceResource
- Jsonrpc
Batch Request Item - JsonrpcBatchRequestItem
- Jsonrpc
Batch Response Item - JsonrpcBatchResponseItem
- Jsonrpc
Message Subtype2 Item - JsonrpcMessageSubtype2Item
- Jsonrpc
Message Subtype5 Item - JsonrpcMessageSubtype5Item
- Logging
Level - The severity of a log message.
- Prompt
Message Content - PromptMessageContent
- Read
Resource Result Contents Item - ReadResourceResultContentsItem
- Role
- The sender or recipient of messages and data in a conversation.
- Sampling
Message Content - SamplingMessageContent
- Server
Notification - ServerNotification
- Server
Request - ServerRequest
- Server
Result - ServerResult