Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Class McpSchema

java.lang.Object

io.modelcontextprotocol.spec.McpSchema

public final class McpSchema
extends Object

Based on the JSON-RPC 2.0 specification and the Model Context Protocol Schema.

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	McpSchema.Annotated	Base for objects that include optional annotations for the client.
static final record	McpSchema.Annotations	Optional annotations for the client.
static final record	McpSchema.BlobResourceContents	Binary contents of a resource.
static final record	McpSchema.CallToolRequest	Used by the client to call a tool provided by the server.
static final record	McpSchema.CallToolResult	The server's response to a tools/call request from the client.
static final record	McpSchema.ClientCapabilities	Clients can implement additional features to enrich connected MCP servers with additional capabilities.
static interface	McpSchema.CompleteReference
static final record	McpSchema.CompleteRequest
static final record	McpSchema.CompleteResult
static interface	McpSchema.Content
static final record	McpSchema.CreateMessageRequest
static final record	McpSchema.CreateMessageResult
static final record	McpSchema.EmbeddedResource
static final class	McpSchema.ErrorCodes	Standard error codes used in MCP JSON-RPC responses.
static final record	McpSchema.GetPromptRequest	Used by the client to get a prompt provided by the server.
static final record	McpSchema.GetPromptResult	The server's response to a prompts/get request from the client.
static final record	McpSchema.ImageContent
static final record	McpSchema.Implementation
static final record	McpSchema.InitializeRequest
static final record	McpSchema.InitializeResult
static interface	McpSchema.JSONRPCMessage
static final record	McpSchema.JSONRPCNotification
static final record	McpSchema.JSONRPCRequest
static final record	McpSchema.JSONRPCResponse
static final record	McpSchema.JsonSchema
static final record	McpSchema.ListPromptsResult	The server's response to a prompts/list request from the client.
static final record	McpSchema.ListResourcesResult
static final record	McpSchema.ListResourceTemplatesResult
static final record	McpSchema.ListRootsResult	The client's response to a roots/list request from the server.
static final record	McpSchema.ListToolsResult	The server's response to a tools/list request from the client.
static enum	McpSchema.LoggingLevel
static final record	McpSchema.LoggingMessageNotification	The Model Context Protocol (MCP) provides a standardized way for servers to send structured log messages to clients.
static final record	McpSchema.ModelHint
static final record	McpSchema.ModelPreferences
static final record	McpSchema.PaginatedRequest
static final record	McpSchema.PaginatedResult
static final record	McpSchema.ProgressNotification
static final record	McpSchema.Prompt	A prompt or prompt template that the server offers.
static final record	McpSchema.PromptArgument	Describes an argument that a prompt can accept.
static final record	McpSchema.PromptMessage	Describes a message returned as part of a prompt.
static final record	McpSchema.PromptReference
static final record	McpSchema.ReadResourceRequest
static final record	McpSchema.ReadResourceResult
static interface	McpSchema.Request
static final record	McpSchema.Resource	A known resource that the server is capable of reading.
static interface	McpSchema.ResourceContents	The contents of a specific resource or sub-resource.
static final record	McpSchema.ResourceReference
static final record	McpSchema.ResourceTemplate	Resource templates allow servers to expose parameterized resources using URI templates.
static enum	McpSchema.Role
static final record	McpSchema.Root	Represents a root directory or file that the server can operate on.
static final record	McpSchema.SamplingMessage
static final record	McpSchema.ServerCapabilities
static final record	McpSchema.SetLevelRequest
static final record	McpSchema.SubscribeRequest	Sent from the client to request resources/updated notifications from the server whenever a particular resource changes.
static final record	McpSchema.TextContent
static final record	McpSchema.TextResourceContents	Text contents of a resource.
static final record	McpSchema.Tool	Represents a tool that the server provides.
static final record	McpSchema.UnsubscribeRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSONRPC_VERSION
static final String	LATEST_PROTOCOL_VERSION
static final String	METHOD_COMPLETION_COMPLETE
static final String	METHOD_INITIALIZE
static final String	METHOD_LOGGING_SET_LEVEL
static final String	METHOD_NOTIFICATION_INITIALIZED
static final String	METHOD_NOTIFICATION_MESSAGE
static final String	METHOD_NOTIFICATION_PROMPTS_LIST_CHANGED
static final String	METHOD_NOTIFICATION_RESOURCES_LIST_CHANGED
static final String	METHOD_NOTIFICATION_ROOTS_LIST_CHANGED
static final String	METHOD_NOTIFICATION_TOOLS_LIST_CHANGED
static final String	METHOD_PING
static final String	METHOD_PROMPT_GET
static final String	METHOD_PROMPT_LIST
static final String	METHOD_RESOURCES_LIST
static final String	METHOD_RESOURCES_READ
static final String	METHOD_RESOURCES_SUBSCRIBE
static final String	METHOD_RESOURCES_TEMPLATES_LIST
static final String	METHOD_RESOURCES_UNSUBSCRIBE
static final String	METHOD_ROOTS_LIST
static final String	METHOD_SAMPLING_CREATE_MESSAGE
static final String	METHOD_TOOLS_CALL
static final String	METHOD_TOOLS_LIST

Method Summary

Modifier and Type	Method	Description
static McpSchema.JSONRPCMessage	deserializeJsonRpcMessage(com.fasterxml.jackson.databind.ObjectMapper objectMapper, String jsonText)	Deserializes a JSON string into a JSONRPCMessage object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LATEST_PROTOCOL_VERSION

public static final String LATEST_PROTOCOL_VERSION

See Also:

• Constant Field Values

JSONRPC_VERSION

public static final String JSONRPC_VERSION

See Also:

• Constant Field Values

METHOD_INITIALIZE

public static final String METHOD_INITIALIZE

See Also:

• Constant Field Values

METHOD_NOTIFICATION_INITIALIZED

public static final String METHOD_NOTIFICATION_INITIALIZED

See Also:

• Constant Field Values

METHOD_PING

public static final String METHOD_PING

See Also:

• Constant Field Values

METHOD_TOOLS_LIST

public static final String METHOD_TOOLS_LIST

See Also:

• Constant Field Values

METHOD_TOOLS_CALL

public static final String METHOD_TOOLS_CALL

See Also:

• Constant Field Values

METHOD_NOTIFICATION_TOOLS_LIST_CHANGED

public static final String METHOD_NOTIFICATION_TOOLS_LIST_CHANGED

See Also:

• Constant Field Values

METHOD_RESOURCES_LIST

public static final String METHOD_RESOURCES_LIST

See Also:

• Constant Field Values

METHOD_RESOURCES_READ

public static final String METHOD_RESOURCES_READ

See Also:

• Constant Field Values

METHOD_NOTIFICATION_RESOURCES_LIST_CHANGED

public static final String METHOD_NOTIFICATION_RESOURCES_LIST_CHANGED

See Also:

• Constant Field Values

METHOD_RESOURCES_TEMPLATES_LIST

public static final String METHOD_RESOURCES_TEMPLATES_LIST

See Also:

• Constant Field Values

METHOD_RESOURCES_SUBSCRIBE

public static final String METHOD_RESOURCES_SUBSCRIBE

See Also:

• Constant Field Values

METHOD_RESOURCES_UNSUBSCRIBE

public static final String METHOD_RESOURCES_UNSUBSCRIBE

See Also:

• Constant Field Values

METHOD_PROMPT_LIST

public static final String METHOD_PROMPT_LIST

See Also:

• Constant Field Values

METHOD_PROMPT_GET

public static final String METHOD_PROMPT_GET

See Also:

• Constant Field Values

METHOD_NOTIFICATION_PROMPTS_LIST_CHANGED

public static final String METHOD_NOTIFICATION_PROMPTS_LIST_CHANGED

See Also:

• Constant Field Values

METHOD_COMPLETION_COMPLETE

public static final String METHOD_COMPLETION_COMPLETE

See Also:

• Constant Field Values

METHOD_LOGGING_SET_LEVEL

public static final String METHOD_LOGGING_SET_LEVEL

See Also:

• Constant Field Values

METHOD_NOTIFICATION_MESSAGE

public static final String METHOD_NOTIFICATION_MESSAGE

See Also:

• Constant Field Values

METHOD_ROOTS_LIST

public static final String METHOD_ROOTS_LIST

See Also:

• Constant Field Values

METHOD_NOTIFICATION_ROOTS_LIST_CHANGED

public static final String METHOD_NOTIFICATION_ROOTS_LIST_CHANGED

See Also:

• Constant Field Values

METHOD_SAMPLING_CREATE_MESSAGE

public static final String METHOD_SAMPLING_CREATE_MESSAGE

See Also:

• Constant Field Values

Method Details

deserializeJsonRpcMessage

public static McpSchema.JSONRPCMessage deserializeJsonRpcMessage(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 String jsonText)
                                                          throws IOException

Deserializes a JSON string into a JSONRPCMessage object.

Parameters:

objectMapper - The ObjectMapper instance to use for deserialization

jsonText - The JSON string to deserialize

Returns:

A JSONRPCMessage instance using either the McpSchema.JSONRPCRequest, McpSchema.JSONRPCNotification, or McpSchema.JSONRPCResponse classes.

Throws:

IOException - If there's an error during deserialization

IllegalArgumentException - If the JSON structure doesn't match any known message type