Index

A B C D E F G H I J L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addContent(McpSchema.Content) - Method in class io.modelcontextprotocol.spec.McpSchema.CallToolResult.Builder
Adds a content item to the tool result.
addEnvVar(String, String) - Method in class io.modelcontextprotocol.client.transport.ServerParameters.Builder
 
addHint(String) - Method in class io.modelcontextprotocol.spec.McpSchema.ModelPreferences.Builder
 
additionalProperties() - Method in record class io.modelcontextprotocol.spec.McpSchema.JsonSchema
Returns the value of the additionalProperties record component.
addPrompt(McpServerFeatures.AsyncPromptSpecification) - Method in class io.modelcontextprotocol.server.McpAsyncServer
Add a new prompt handler at runtime.
addPrompt(McpServerFeatures.SyncPromptSpecification) - Method in class io.modelcontextprotocol.server.McpSyncServer
Add a new prompt handler.
addResource(McpServerFeatures.AsyncResourceSpecification) - Method in class io.modelcontextprotocol.server.McpAsyncServer
Add a new resource handler at runtime.
addResource(McpServerFeatures.SyncResourceSpecification) - Method in class io.modelcontextprotocol.server.McpSyncServer
Add a new resource handler.
addRoot(McpSchema.Root) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Adds a new root to the client's root list.
addRoot(McpSchema.Root) - Method in class io.modelcontextprotocol.client.McpSyncClient
Add a roots dynamically.
addTextContent(String) - Method in class io.modelcontextprotocol.spec.McpSchema.CallToolResult.Builder
Adds a text content item to the tool result.
addTool(McpServerFeatures.AsyncToolSpecification) - Method in class io.modelcontextprotocol.server.McpAsyncServer
Add a new tool specification at runtime.
addTool(McpServerFeatures.SyncToolSpecification) - Method in class io.modelcontextprotocol.server.McpSyncServer
Add a new tool handler.
ALERT - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.LoggingLevel
 
ALL_SERVERS - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.ContextInclusionStrategy
 
annotations() - Method in interface io.modelcontextprotocol.spec.McpSchema.Annotated
 
annotations() - Method in record class io.modelcontextprotocol.spec.McpSchema.Resource
Returns the value of the annotations record component.
annotations() - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceTemplate
Returns the value of the annotations record component.
Annotations(List<McpSchema.Role>, Double) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.Annotations
Creates an instance of a Annotations record class.
APPLICATION_JSON - Static variable in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
 
arg(String) - Method in class io.modelcontextprotocol.client.transport.ServerParameters.Builder
 
args(String...) - Method in class io.modelcontextprotocol.client.transport.ServerParameters.Builder
 
args(List<String>) - Method in class io.modelcontextprotocol.client.transport.ServerParameters.Builder
 
argument() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteRequest
Returns the value of the argument record component.
arguments() - Method in record class io.modelcontextprotocol.spec.McpSchema.CallToolRequest
Returns the value of the arguments record component.
arguments() - Method in record class io.modelcontextprotocol.spec.McpSchema.GetPromptRequest
Returns the value of the arguments record component.
arguments() - Method in record class io.modelcontextprotocol.spec.McpSchema.Prompt
Returns the value of the arguments record component.
Assert - Class in io.modelcontextprotocol.util
Utility class providing assertion methods for parameter validation.
Assert() - Constructor for class io.modelcontextprotocol.util.Assert
 
ASSISTANT - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.Role
 
async(McpClientTransport) - Static method in interface io.modelcontextprotocol.client.McpClient
Start building an asynchronous MCP client with the specified transport layer.
async(McpServerTransportProvider) - Static method in interface io.modelcontextprotocol.server.McpServer
Starts building an asynchronous MCP server that provides non-blocking operations.
AsyncCompletionSpecification(McpSchema.CompleteReference, BiFunction<McpAsyncServerExchange, McpSchema.CompleteRequest, Mono<McpSchema.CompleteResult>>) - Constructor for record class io.modelcontextprotocol.server.McpServerFeatures.AsyncCompletionSpecification
Creates an instance of a AsyncCompletionSpecification record class.
AsyncPromptSpecification(McpSchema.Prompt, BiFunction<McpAsyncServerExchange, McpSchema.GetPromptRequest, Mono<McpSchema.GetPromptResult>>) - Constructor for record class io.modelcontextprotocol.server.McpServerFeatures.AsyncPromptSpecification
Creates an instance of a AsyncPromptSpecification record class.
AsyncResourceSpecification(McpSchema.Resource, BiFunction<McpAsyncServerExchange, McpSchema.ReadResourceRequest, Mono<McpSchema.ReadResourceResult>>) - Constructor for record class io.modelcontextprotocol.server.McpServerFeatures.AsyncResourceSpecification
Creates an instance of a AsyncResourceSpecification record class.
AsyncToolSpecification(McpSchema.Tool, BiFunction<McpAsyncServerExchange, Map<String, Object>, Mono<McpSchema.CallToolResult>>) - Constructor for record class io.modelcontextprotocol.server.McpServerFeatures.AsyncToolSpecification
Creates an instance of a AsyncToolSpecification record class.
audience() - Method in record class io.modelcontextprotocol.spec.McpSchema.Annotations
Returns the value of the audience record component.
audience() - Method in record class io.modelcontextprotocol.spec.McpSchema.EmbeddedResource
Returns the value of the audience record component.
audience() - Method in record class io.modelcontextprotocol.spec.McpSchema.ImageContent
Returns the value of the audience record component.
audience() - Method in record class io.modelcontextprotocol.spec.McpSchema.TextContent
Returns the value of the audience record component.
awaitForExit() - Method in class io.modelcontextprotocol.client.transport.StdioClientTransport
Waits for the server process to exit.

B

baseUrl(String) - Method in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider.Builder
Sets the base URL for the server transport.
blob() - Method in record class io.modelcontextprotocol.spec.McpSchema.BlobResourceContents
Returns the value of the blob record component.
BlobResourceContents(String, String, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.BlobResourceContents
Creates an instance of a BlobResourceContents record class.
build() - Method in class io.modelcontextprotocol.client.McpClient.AsyncSpec
Create an instance of McpAsyncClient with the provided configurations or sensible defaults.
build() - Method in class io.modelcontextprotocol.client.McpClient.SyncSpec
Create an instance of McpSyncClient with the provided configurations or sensible defaults.
build() - Method in class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport.Builder
Builds a new HttpClientSseClientTransport instance.
build() - Method in class io.modelcontextprotocol.client.transport.ServerParameters.Builder
 
build() - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Builds an asynchronous MCP server that provides non-blocking operations.
build() - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Builds a synchronous MCP server that provides blocking operations.
build() - Method in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider.Builder
Builds a new instance of HttpServletSseServerTransportProvider with the configured settings.
build() - Method in class io.modelcontextprotocol.spec.McpSchema.CallToolResult.Builder
Builds a new McpSchema.CallToolResult instance.
build() - Method in class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.Builder
 
build() - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.Builder
 
build() - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult.Builder
 
build() - Method in class io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification.Builder
 
build() - Method in class io.modelcontextprotocol.spec.McpSchema.ModelPreferences.Builder
 
build() - Method in class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.Builder
 
builder() - Static method in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
Creates a new Builder instance for configuring and creating instances of HttpServletSseServerTransportProvider.
builder() - Static method in record class io.modelcontextprotocol.spec.McpSchema.CallToolResult
Creates a builder for McpSchema.CallToolResult.
builder() - Static method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities
 
builder() - Static method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest
 
builder() - Static method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult
 
builder() - Static method in record class io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification
 
builder() - Static method in record class io.modelcontextprotocol.spec.McpSchema.ModelPreferences
 
builder() - Static method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities
 
builder(String) - Static method in class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport
Creates a new builder for HttpClientSseClientTransport.
builder(String) - Static method in class io.modelcontextprotocol.client.transport.ServerParameters
 
Builder() - Constructor for class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider.Builder
 
Builder() - Constructor for class io.modelcontextprotocol.spec.McpSchema.CallToolResult.Builder
 
Builder() - Constructor for class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.Builder
 
Builder() - Constructor for class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.Builder
 
Builder() - Constructor for class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult.Builder
 
Builder() - Constructor for class io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification.Builder
 
Builder() - Constructor for class io.modelcontextprotocol.spec.McpSchema.ModelPreferences.Builder
 
Builder() - Constructor for class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.Builder
 
Builder(String) - Constructor for class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport.Builder
Deprecated, for removal: This API element is subject to removal in a future version.
Use HttpClientSseClientTransport.builder(String) instead. This constructor is deprecated and will be removed or made protected or private in a future release.
Builder(String) - Constructor for class io.modelcontextprotocol.client.transport.ServerParameters.Builder
 

C

call() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncToolSpecification
Returns the value of the call record component.
call() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncToolSpecification
Returns the value of the call record component.
callTool(McpSchema.CallToolRequest) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Calls a tool provided by the server.
callTool(McpSchema.CallToolRequest) - Method in class io.modelcontextprotocol.client.McpSyncClient
Calls a tool provided by the server.
CallToolRequest(String, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.CallToolRequest
 
CallToolRequest(String, Map<String, Object>) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.CallToolRequest
Creates an instance of a CallToolRequest record class.
CallToolResult(String, Boolean) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.CallToolResult
Creates a new instance of McpSchema.CallToolResult with a string containing the tool result.
CallToolResult(List<McpSchema.Content>, Boolean) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.CallToolResult
Creates an instance of a CallToolResult record class.
capabilities() - Method in record class io.modelcontextprotocol.spec.McpSchema.InitializeRequest
Returns the value of the capabilities record component.
capabilities() - Method in record class io.modelcontextprotocol.spec.McpSchema.InitializeResult
Returns the value of the capabilities record component.
capabilities(McpSchema.ClientCapabilities) - Method in class io.modelcontextprotocol.client.McpClient.AsyncSpec
Sets the client capabilities that will be advertised to the server during connection initialization.
capabilities(McpSchema.ClientCapabilities) - Method in class io.modelcontextprotocol.client.McpClient.SyncSpec
Sets the client capabilities that will be advertised to the server during connection initialization.
capabilities(McpSchema.ServerCapabilities) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Sets the server capabilities that will be advertised to clients during connection initialization.
capabilities(McpSchema.ServerCapabilities) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Sets the server capabilities that will be advertised to clients during connection initialization.
clientBuilder(HttpClient.Builder) - Method in class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport.Builder
Sets the HTTP client builder.
ClientCapabilities(Map<String, Object>, McpSchema.ClientCapabilities.RootCapabilities, McpSchema.ClientCapabilities.Sampling) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities
Creates an instance of a ClientCapabilities record class.
clientInfo() - Method in record class io.modelcontextprotocol.spec.McpSchema.InitializeRequest
Returns the value of the clientInfo record component.
clientInfo(McpSchema.Implementation) - Method in class io.modelcontextprotocol.client.McpClient.AsyncSpec
Sets the client implementation information that will be shared with the server during connection initialization.
clientInfo(McpSchema.Implementation) - Method in class io.modelcontextprotocol.client.McpClient.SyncSpec
Sets the client implementation information that will be shared with the server during connection initialization.
close() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Closes the client connection immediately.
close() - Method in class io.modelcontextprotocol.client.McpSyncClient
 
close() - Method in class io.modelcontextprotocol.server.McpAsyncServer
Close the server immediately.
close() - Method in class io.modelcontextprotocol.server.McpSyncServer
Close the server immediately.
close() - Method in class io.modelcontextprotocol.spec.McpClientSession
Closes the session immediately, potentially interrupting pending operations.
close() - Method in class io.modelcontextprotocol.spec.McpServerSession
 
close() - Method in interface io.modelcontextprotocol.spec.McpServerTransportProvider
Immediately closes all the transports with connected clients and releases any associated resources.
close() - Method in interface io.modelcontextprotocol.spec.McpSession
Closes the session and releases any associated resources.
close() - Method in interface io.modelcontextprotocol.spec.McpTransport
Closes the transport connection and releases any associated resources.
closeGracefully() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Gracefully closes the client connection.
closeGracefully() - Method in class io.modelcontextprotocol.client.McpSyncClient
 
closeGracefully() - Method in class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport
Gracefully closes the transport connection.
closeGracefully() - Method in class io.modelcontextprotocol.client.transport.StdioClientTransport
Gracefully closes the transport by destroying the process and disposing of the schedulers.
closeGracefully() - Method in class io.modelcontextprotocol.server.McpAsyncServer
Gracefully closes the server, allowing any in-progress operations to complete.
closeGracefully() - Method in class io.modelcontextprotocol.server.McpSyncServer
Close the server gracefully.
closeGracefully() - Method in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
Initiates a graceful shutdown of the transport.
closeGracefully() - Method in class io.modelcontextprotocol.server.transport.StdioServerTransportProvider
 
closeGracefully() - Method in class io.modelcontextprotocol.spec.McpClientSession
Closes the session gracefully, allowing pending operations to complete.
closeGracefully() - Method in class io.modelcontextprotocol.spec.McpServerSession
 
closeGracefully() - Method in interface io.modelcontextprotocol.spec.McpServerTransportProvider
Gracefully closes all the transports with connected clients and releases any associated resources asynchronously.
closeGracefully() - Method in interface io.modelcontextprotocol.spec.McpSession
Closes the session and releases any associated resources asynchronously.
closeGracefully() - Method in interface io.modelcontextprotocol.spec.McpTransport
Closes the transport connection and releases any associated resources asynchronously.
code() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse.JSONRPCError
Returns the value of the code record component.
CompleteArgument(String, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.CompleteRequest.CompleteArgument
Creates an instance of a CompleteArgument record class.
completeCompletion(McpSchema.CompleteRequest) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Sends a completion/complete request to generate value suggestions based on a given reference and argument.
completeCompletion(McpSchema.CompleteRequest) - Method in class io.modelcontextprotocol.client.McpSyncClient
Send a completion/complete request.
CompleteCompletion(List<String>, Integer, Boolean) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.CompleteResult.CompleteCompletion
Creates an instance of a CompleteCompletion record class.
CompleteRequest(McpSchema.CompleteReference, McpSchema.CompleteRequest.CompleteArgument) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.CompleteRequest
Creates an instance of a CompleteRequest record class.
CompleteResult(McpSchema.CompleteResult.CompleteCompletion) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.CompleteResult
Creates an instance of a CompleteResult record class.
completion() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteResult
Returns the value of the completion record component.
CompletionCapabilities() - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.CompletionCapabilities
Creates an instance of a CompletionCapabilities record class.
completionHandler() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncCompletionSpecification
Returns the value of the completionHandler record component.
completionHandler() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncCompletionSpecification
Returns the value of the completionHandler record component.
completions() - Method in class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.Builder
 
completions() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities
Returns the value of the completions record component.
completions(McpServerFeatures.AsyncCompletionSpecification...) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Registers multiple completions with their handlers using varargs.
completions(McpServerFeatures.SyncCompletionSpecification...) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Registers multiple completions with their handlers using varargs.
completions(List<McpServerFeatures.AsyncCompletionSpecification>) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Registers multiple completions with their handlers using a List.
completions(List<McpServerFeatures.SyncCompletionSpecification>) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Registers multiple completions with their handlers using a List.
connect(Function<Mono<McpSchema.JSONRPCMessage>, Mono<McpSchema.JSONRPCMessage>>) - Method in class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport
Establishes the SSE connection with the server and sets up message handling.
connect(Function<Mono<McpSchema.JSONRPCMessage>, Mono<McpSchema.JSONRPCMessage>>) - Method in class io.modelcontextprotocol.client.transport.StdioClientTransport
Starts the server process and initializes the message processing streams.
connect(Function<Mono<McpSchema.JSONRPCMessage>, Mono<McpSchema.JSONRPCMessage>>) - Method in interface io.modelcontextprotocol.spec.McpClientTransport
 
content() - Method in record class io.modelcontextprotocol.spec.McpSchema.CallToolResult
Returns the value of the content record component.
content() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult
Returns the value of the content record component.
content() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptMessage
Returns the value of the content record component.
content() - Method in record class io.modelcontextprotocol.spec.McpSchema.SamplingMessage
Returns the value of the content record component.
content(McpSchema.Content) - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult.Builder
 
content(List<McpSchema.Content>) - Method in class io.modelcontextprotocol.spec.McpSchema.CallToolResult.Builder
Sets the content list for the tool result.
contents() - Method in record class io.modelcontextprotocol.spec.McpSchema.ReadResourceResult
Returns the value of the contents record component.
costPriority() - Method in record class io.modelcontextprotocol.spec.McpSchema.ModelPreferences
Returns the value of the costPriority record component.
costPriority(Double) - Method in class io.modelcontextprotocol.spec.McpSchema.ModelPreferences.Builder
 
create(McpServerTransport) - Method in interface io.modelcontextprotocol.spec.McpServerSession.Factory
Creates a new 1:1 representation of the client-server interaction.
create(String) - Method in class io.modelcontextprotocol.util.DeafaultMcpUriTemplateManagerFactory
Creates a new instance of McpUriTemplateManager with the specified URI template.
create(String) - Method in interface io.modelcontextprotocol.util.McpUriTemplateManagerFactory
Creates a new instance of McpUriTemplateManager with the specified URI template.
createMessage(McpSchema.CreateMessageRequest) - Method in class io.modelcontextprotocol.server.McpAsyncServerExchange
Create a new message using the sampling capabilities of the client.
createMessage(McpSchema.CreateMessageRequest) - Method in class io.modelcontextprotocol.server.McpSyncServerExchange
Create a new message using the sampling capabilities of the client.
CreateMessageRequest(List<McpSchema.SamplingMessage>, McpSchema.ModelPreferences, String, McpSchema.CreateMessageRequest.ContextInclusionStrategy, Double, int, List<String>, Map<String, Object>) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest
Creates an instance of a CreateMessageRequest record class.
CreateMessageResult(McpSchema.Role, McpSchema.Content, String, McpSchema.CreateMessageResult.StopReason) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult
Creates an instance of a CreateMessageResult record class.
CRITICAL - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.LoggingLevel
 
cursor() - Method in record class io.modelcontextprotocol.spec.McpSchema.PaginatedRequest
Returns the value of the cursor record component.
customizeClient(Consumer<HttpClient.Builder>) - Method in class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport.Builder
Customizes the HTTP client builder.
customizeRequest(Consumer<HttpRequest.Builder>) - Method in class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport.Builder
Customizes the HTTP client builder.

D

data() - Method in record class io.modelcontextprotocol.client.transport.FlowSseClient.SseEvent
Returns the value of the data record component.
data() - Method in record class io.modelcontextprotocol.spec.McpSchema.ImageContent
Returns the value of the data record component.
data() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse.JSONRPCError
Returns the value of the data record component.
data() - Method in record class io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification
Returns the value of the data record component.
data(String) - Method in class io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification.Builder
 
DeafaultMcpUriTemplateManagerFactory - Class in io.modelcontextprotocol.util
 
DeafaultMcpUriTemplateManagerFactory() - Constructor for class io.modelcontextprotocol.util.DeafaultMcpUriTemplateManagerFactory
 
DEBUG - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.LoggingLevel
 
DEFAULT_BASE_URL - Static variable in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
 
DEFAULT_SSE_ENDPOINT - Static variable in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
Default endpoint path for SSE connections
DefaultMcpUriTemplateManager - Class in io.modelcontextprotocol.util
Default implementation of the UriTemplateUtils interface.
DefaultMcpUriTemplateManager(String) - Constructor for class io.modelcontextprotocol.util.DefaultMcpUriTemplateManager
Constructor for DefaultMcpUriTemplateManager.
definitions() - Method in record class io.modelcontextprotocol.spec.McpSchema.JsonSchema
Returns the value of the definitions record component.
defs() - Method in record class io.modelcontextprotocol.spec.McpSchema.JsonSchema
Returns the value of the defs record component.
description() - Method in record class io.modelcontextprotocol.spec.McpSchema.GetPromptResult
Returns the value of the description record component.
description() - Method in record class io.modelcontextprotocol.spec.McpSchema.Prompt
Returns the value of the description record component.
description() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptArgument
Returns the value of the description record component.
description() - Method in record class io.modelcontextprotocol.spec.McpSchema.Resource
Returns the value of the description record component.
description() - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceTemplate
Returns the value of the description record component.
description() - Method in record class io.modelcontextprotocol.spec.McpSchema.Tool
Returns the value of the description record component.
deserializeJsonRpcMessage(ObjectMapper, String) - Static method in class io.modelcontextprotocol.spec.McpSchema
Deserializes a JSON string into a JSONRPCMessage object.
destroy() - Method in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
Cleans up resources when the servlet is being destroyed.
doGet(HttpServletRequest, HttpServletResponse) - Method in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
Handles GET requests to establish SSE connections.
doPost(HttpServletRequest, HttpServletResponse) - Method in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
Handles POST requests for client messages.

E

EmbeddedResource(List<McpSchema.Role>, Double, McpSchema.ResourceContents) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.EmbeddedResource
Creates an instance of a EmbeddedResource record class.
EMERGENCY - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.LoggingLevel
 
END_TURN - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult.StopReason
 
ENDPOINT_EVENT_TYPE - Static variable in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
Event type for endpoint information
env(Map<String, String>) - Method in class io.modelcontextprotocol.client.transport.ServerParameters.Builder
 
equals(Object) - Method in record class io.modelcontextprotocol.client.transport.FlowSseClient.SseEvent
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncCompletionSpecification
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncPromptSpecification
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncResourceSpecification
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncToolSpecification
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncCompletionSpecification
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncPromptSpecification
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncResourceSpecification
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncToolSpecification
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.Annotations
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.BlobResourceContents
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.CallToolRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.CallToolResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.RootCapabilities
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.Sampling
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteRequest.CompleteArgument
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteResult.CompleteCompletion
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.EmbeddedResource
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.GetPromptRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.GetPromptResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ImageContent
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.Implementation
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.InitializeRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.InitializeResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCNotification
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse.JSONRPCError
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.JsonSchema
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ListPromptsResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ListResourcesResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ListResourceTemplatesResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ListRootsResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ListToolsResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ModelHint
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ModelPreferences
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.PaginatedRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.PaginatedResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ProgressNotification
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.Prompt
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptArgument
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptMessage
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptReference
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ReadResourceRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ReadResourceResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.Resource
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceReference
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceTemplate
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.Root
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.SamplingMessage
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.CompletionCapabilities
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.LoggingCapabilities
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.PromptCapabilities
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.ResourceCapabilities
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.ToolCapabilities
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.SetLevelRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.SubscribeRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.TextContent
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.TextResourceContents
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.Tool
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.modelcontextprotocol.spec.McpSchema.UnsubscribeRequest
Indicates whether some other object is "equal to" this one.
error() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse
Returns the value of the error record component.
ERROR - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.LoggingLevel
 
ErrorCodes() - Constructor for class io.modelcontextprotocol.spec.McpSchema.ErrorCodes
 
experimental() - Method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities
Returns the value of the experimental record component.
experimental() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities
Returns the value of the experimental record component.
experimental(Map<String, Object>) - Method in class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.Builder
 
experimental(Map<String, Object>) - Method in class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.Builder
 
extractVariableValues(String) - Method in class io.modelcontextprotocol.util.DefaultMcpUriTemplateManager
Extract URI variable values from the actual request URI.
extractVariableValues(String) - Method in interface io.modelcontextprotocol.util.McpUriTemplateManager
Extract URI variable values from the actual request URI.

F

FAILED_TO_SEND_ERROR_RESPONSE - Static variable in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
 
FlowSseClient - Class in io.modelcontextprotocol.client.transport
A Server-Sent Events (SSE) client implementation using Java's Flow API for reactive stream processing.
FlowSseClient(HttpClient) - Constructor for class io.modelcontextprotocol.client.transport.FlowSseClient
Creates a new FlowSseClient with the specified HTTP client.
FlowSseClient(HttpClient, HttpRequest.Builder) - Constructor for class io.modelcontextprotocol.client.transport.FlowSseClient
Creates a new FlowSseClient with the specified HTTP client and request builder.
FlowSseClient.SseEvent - Record Class in io.modelcontextprotocol.client.transport
Record class representing a Server-Sent Event with its standard fields.
FlowSseClient.SseEventHandler - Interface in io.modelcontextprotocol.client.transport
Interface for handling SSE events and errors.

G

getArgs() - Method in class io.modelcontextprotocol.client.transport.ServerParameters
 
getAsyncServer() - Method in class io.modelcontextprotocol.server.McpSyncServer
Get the underlying async server instance.
getClientCapabilities() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Get the client capabilities that define the supported features and functionality.
getClientCapabilities() - Method in class io.modelcontextprotocol.client.McpSyncClient
Get the client capabilities that define the supported features and functionality.
getClientCapabilities() - Method in class io.modelcontextprotocol.server.McpAsyncServerExchange
Get the client capabilities that define the supported features and functionality.
getClientCapabilities() - Method in class io.modelcontextprotocol.server.McpSyncServerExchange
Get the client capabilities that define the supported features and functionality.
getClientInfo() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Get the client implementation information.
getClientInfo() - Method in class io.modelcontextprotocol.client.McpSyncClient
Get the client implementation information.
getClientInfo() - Method in class io.modelcontextprotocol.server.McpAsyncServerExchange
Get the client implementation information.
getClientInfo() - Method in class io.modelcontextprotocol.server.McpSyncServerExchange
Get the client implementation information.
getCommand() - Method in class io.modelcontextprotocol.client.transport.ServerParameters
 
getEnv() - Method in class io.modelcontextprotocol.client.transport.ServerParameters
 
getErrorSink() - Method in class io.modelcontextprotocol.client.transport.StdioClientTransport
 
getId() - Method in class io.modelcontextprotocol.spec.McpServerSession
Retrieve the session id.
getJsonRpcError() - Method in exception io.modelcontextprotocol.spec.McpError
 
getProcessBuilder() - Method in class io.modelcontextprotocol.client.transport.StdioClientTransport
Creates and returns a new ProcessBuilder instance.
getPrompt(McpSchema.GetPromptRequest) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Retrieves a specific prompt by its ID.
getPrompt(McpSchema.GetPromptRequest) - Method in class io.modelcontextprotocol.client.McpSyncClient
 
GetPromptRequest(String, Map<String, Object>) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.GetPromptRequest
Creates an instance of a GetPromptRequest record class.
GetPromptResult(String, List<McpSchema.PromptMessage>) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.GetPromptResult
Creates an instance of a GetPromptResult record class.
getServerCapabilities() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Get the server capabilities that define the supported features and functionality.
getServerCapabilities() - Method in class io.modelcontextprotocol.client.McpSyncClient
Get the server capabilities that define the supported features and functionality.
getServerCapabilities() - Method in class io.modelcontextprotocol.server.McpAsyncServer
Get the server capabilities that define the supported features and functionality.
getServerCapabilities() - Method in class io.modelcontextprotocol.server.McpSyncServer
Get the server capabilities that define the supported features and functionality.
getServerInfo() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Get the server implementation information.
getServerInfo() - Method in class io.modelcontextprotocol.client.McpSyncClient
Get the server implementation information.
getServerInfo() - Method in class io.modelcontextprotocol.server.McpAsyncServer
Get the server implementation information.
getServerInfo() - Method in class io.modelcontextprotocol.server.McpSyncServer
Get the server implementation information.
getServerInstructions() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Get the server instructions that provide guidance to the client on how to interact with this server.
getServerInstructions() - Method in class io.modelcontextprotocol.client.McpSyncClient
Get the server instructions that provide guidance to the client on how to interact with this server.
getVariableNames() - Method in class io.modelcontextprotocol.util.DefaultMcpUriTemplateManager
Extract URI variable names from a URI template.
getVariableNames() - Method in interface io.modelcontextprotocol.util.McpUriTemplateManager
Extract URI variable names from this URI template.

H

handle() - Method in interface io.modelcontextprotocol.spec.McpServerSession.InitNotificationHandler
Specifies an action to take upon successful initialization.
handle(McpAsyncServerExchange, Object) - Method in interface io.modelcontextprotocol.spec.McpServerSession.NotificationHandler
Handles a notification from the client.
handle(McpAsyncServerExchange, Object) - Method in interface io.modelcontextprotocol.spec.McpServerSession.RequestHandler
Handles a request from the client.
handle(McpSchema.InitializeRequest) - Method in interface io.modelcontextprotocol.spec.McpServerSession.InitRequestHandler
Handles the initialization request.
handle(McpSchema.JSONRPCMessage) - Method in class io.modelcontextprotocol.spec.McpServerSession
Called by the McpServerTransportProvider once the session is determined.
handle(Object) - Method in interface io.modelcontextprotocol.spec.McpClientSession.NotificationHandler
Handles an incoming notification with the given parameters.
handle(Object) - Method in interface io.modelcontextprotocol.spec.McpClientSession.RequestHandler
Handles an incoming request with the given parameters.
handleOutbound(Function<Flux<McpSchema.JSONRPCMessage>, Flux<McpSchema.JSONRPCMessage>>) - Method in class io.modelcontextprotocol.client.transport.StdioClientTransport
 
hashCode() - Method in record class io.modelcontextprotocol.client.transport.FlowSseClient.SseEvent
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncCompletionSpecification
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncPromptSpecification
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncResourceSpecification
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncToolSpecification
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncCompletionSpecification
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncPromptSpecification
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncResourceSpecification
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncToolSpecification
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.Annotations
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.BlobResourceContents
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.CallToolRequest
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.CallToolResult
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.RootCapabilities
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.Sampling
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteRequest.CompleteArgument
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteRequest
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteResult.CompleteCompletion
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteResult
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.EmbeddedResource
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.GetPromptRequest
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.GetPromptResult
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ImageContent
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.Implementation
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.InitializeRequest
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.InitializeResult
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCNotification
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCRequest
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse.JSONRPCError
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.JsonSchema
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListPromptsResult
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListResourcesResult
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListResourceTemplatesResult
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListRootsResult
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListToolsResult
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ModelHint
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ModelPreferences
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.PaginatedRequest
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.PaginatedResult
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ProgressNotification
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.Prompt
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptArgument
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptMessage
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptReference
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ReadResourceRequest
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ReadResourceResult
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.Resource
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceReference
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceTemplate
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.Root
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.SamplingMessage
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.CompletionCapabilities
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.LoggingCapabilities
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.PromptCapabilities
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.ResourceCapabilities
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.ToolCapabilities
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.SetLevelRequest
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.SubscribeRequest
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.TextContent
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.TextResourceContents
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.Tool
Returns a hash code value for this object.
hashCode() - Method in record class io.modelcontextprotocol.spec.McpSchema.UnsubscribeRequest
Returns a hash code value for this object.
hasMore() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteResult.CompleteCompletion
Returns the value of the hasMore record component.
hasText(String) - Static method in class io.modelcontextprotocol.util.Assert
Check whether the given String contains actual text.
hasText(String) - Static method in class io.modelcontextprotocol.util.Utils
Check whether the given String contains actual text.
hasText(String, String) - Static method in class io.modelcontextprotocol.util.Assert
Assert that the given String contains valid text content; that is, it must not be null and must contain at least one non-whitespace character.
hints() - Method in record class io.modelcontextprotocol.spec.McpSchema.ModelPreferences
Returns the value of the hints record component.
hints(List<McpSchema.ModelHint>) - Method in class io.modelcontextprotocol.spec.McpSchema.ModelPreferences.Builder
 
HttpClientSseClientTransport - Class in io.modelcontextprotocol.client.transport
Server-Sent Events (SSE) implementation of the McpTransport that follows the MCP HTTP with SSE transport specification, using Java's HttpClient.
HttpClientSseClientTransport(String) - Constructor for class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport
Deprecated, for removal: This API element is subject to removal in a future version.
Use HttpClientSseClientTransport.builder(String) instead. This constructor will be removed in future versions.
HttpClientSseClientTransport(HttpClient.Builder, String, ObjectMapper) - Constructor for class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport
Deprecated, for removal: This API element is subject to removal in a future version.
Use HttpClientSseClientTransport.builder(String) instead. This constructor will be removed in future versions.
HttpClientSseClientTransport(HttpClient.Builder, String, String, ObjectMapper) - Constructor for class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport
Deprecated, for removal: This API element is subject to removal in a future version.
Use HttpClientSseClientTransport.builder(String) instead. This constructor will be removed in future versions.
HttpClientSseClientTransport(HttpClient.Builder, HttpRequest.Builder, String, String, ObjectMapper) - Constructor for class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport
Deprecated, for removal: This API element is subject to removal in a future version.
Use HttpClientSseClientTransport.builder(String) instead. This constructor will be removed in future versions.
HttpClientSseClientTransport.Builder - Class in io.modelcontextprotocol.client.transport
HttpServletSseServerTransportProvider - Class in io.modelcontextprotocol.server.transport
A Servlet-based implementation of the MCP HTTP with Server-Sent Events (SSE) transport specification.
HttpServletSseServerTransportProvider(ObjectMapper, String) - Constructor for class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
Creates a new HttpServletSseServerTransportProvider instance with the default SSE endpoint.
HttpServletSseServerTransportProvider(ObjectMapper, String, String) - Constructor for class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
Creates a new HttpServletSseServerTransportProvider instance with a custom SSE endpoint.
HttpServletSseServerTransportProvider(ObjectMapper, String, String, String) - Constructor for class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
Creates a new HttpServletSseServerTransportProvider instance with a custom SSE endpoint.
HttpServletSseServerTransportProvider.Builder - Class in io.modelcontextprotocol.server.transport
Builder for creating instances of HttpServletSseServerTransportProvider.

I

id() - Method in record class io.modelcontextprotocol.client.transport.FlowSseClient.SseEvent
Returns the value of the id record component.
id() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCRequest
Returns the value of the id record component.
id() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse
Returns the value of the id record component.
identifier() - Method in interface io.modelcontextprotocol.spec.McpSchema.CompleteReference
 
identifier() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptReference
 
identifier() - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceReference
 
ImageContent(List<McpSchema.Role>, Double, String, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ImageContent
Creates an instance of a ImageContent record class.
Implementation(String, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.Implementation
Creates an instance of a Implementation record class.
includeContext() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest
Returns the value of the includeContext record component.
includeContext(McpSchema.CreateMessageRequest.ContextInclusionStrategy) - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.Builder
 
INFO - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.LoggingLevel
 
init(McpSchema.ClientCapabilities, McpSchema.Implementation) - Method in class io.modelcontextprotocol.spec.McpServerSession
Called upon successful initialization sequence between the client and the server with the client capabilities and information.
initializationTimeout(Duration) - Method in class io.modelcontextprotocol.client.McpClient.AsyncSpec
 
initializationTimeout(Duration) - Method in class io.modelcontextprotocol.client.McpClient.SyncSpec
 
initialize() - Method in class io.modelcontextprotocol.client.McpAsyncClient
The initialization phase MUST be the first interaction between client and server.
initialize() - Method in class io.modelcontextprotocol.client.McpSyncClient
The initialization phase MUST be the first interaction between client and server.
initializedSink - Variable in class io.modelcontextprotocol.client.McpAsyncClient
 
InitializeRequest(String, McpSchema.ClientCapabilities, McpSchema.Implementation) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.InitializeRequest
Creates an instance of a InitializeRequest record class.
InitializeResult(String, McpSchema.ServerCapabilities, McpSchema.Implementation, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.InitializeResult
Creates an instance of a InitializeResult record class.
inputSchema() - Method in record class io.modelcontextprotocol.spec.McpSchema.Tool
Returns the value of the inputSchema record component.
instructions() - Method in record class io.modelcontextprotocol.spec.McpSchema.InitializeResult
Returns the value of the instructions record component.
instructions(String) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Sets the server instructions that will be shared with clients during connection initialization.
instructions(String) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Sets the server instructions that will be shared with clients during connection initialization.
intelligencePriority() - Method in record class io.modelcontextprotocol.spec.McpSchema.ModelPreferences
Returns the value of the intelligencePriority record component.
intelligencePriority(Double) - Method in class io.modelcontextprotocol.spec.McpSchema.ModelPreferences.Builder
 
INTERNAL_ERROR - Static variable in class io.modelcontextprotocol.spec.McpSchema.ErrorCodes
Internal JSON-RPC error.
INVALID_PARAMS - Static variable in class io.modelcontextprotocol.spec.McpSchema.ErrorCodes
Invalid method parameter(s).
INVALID_REQUEST - Static variable in class io.modelcontextprotocol.spec.McpSchema.ErrorCodes
The JSON sent is not a valid Request object.
io.modelcontextprotocol.client - package io.modelcontextprotocol.client
 
io.modelcontextprotocol.client.transport - package io.modelcontextprotocol.client.transport
 
io.modelcontextprotocol.sdk.mcp - module io.modelcontextprotocol.sdk.mcp
 
io.modelcontextprotocol.server - package io.modelcontextprotocol.server
 
io.modelcontextprotocol.server.transport - package io.modelcontextprotocol.server.transport
 
io.modelcontextprotocol.spec - package io.modelcontextprotocol.spec
 
io.modelcontextprotocol.util - package io.modelcontextprotocol.util
 
isEmpty(Collection<?>) - Static method in class io.modelcontextprotocol.util.Utils
Return true if the supplied Collection is null or empty.
isEmpty(Map<?, ?>) - Static method in class io.modelcontextprotocol.util.Utils
Return true if the supplied Map is null or empty.
isError() - Method in record class io.modelcontextprotocol.spec.McpSchema.CallToolResult
Returns the value of the isError record component.
isError(Boolean) - Method in class io.modelcontextprotocol.spec.McpSchema.CallToolResult.Builder
Sets whether the tool execution resulted in an error.
isInitialized() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Check if the client-server connection is initialized.
isInitialized() - Method in class io.modelcontextprotocol.client.McpSyncClient
Check if the client-server connection is initialized.
isUriTemplate(String) - Method in class io.modelcontextprotocol.util.DefaultMcpUriTemplateManager
 
isUriTemplate(String) - Method in interface io.modelcontextprotocol.util.McpUriTemplateManager
Check if the given URI is a URI template.

J

jsonrpc() - Method in interface io.modelcontextprotocol.spec.McpSchema.JSONRPCMessage
 
jsonrpc() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCNotification
Returns the value of the jsonrpc record component.
jsonrpc() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCRequest
Returns the value of the jsonrpc record component.
jsonrpc() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse
Returns the value of the jsonrpc record component.
JSONRPC_VERSION - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
JSONRPCError(int, String, Object) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse.JSONRPCError
Creates an instance of a JSONRPCError record class.
JSONRPCNotification(String, String, Object) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.JSONRPCNotification
Creates an instance of a JSONRPCNotification record class.
JSONRPCRequest(String, String, Object, Object) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.JSONRPCRequest
Creates an instance of a JSONRPCRequest record class.
JSONRPCResponse(String, Object, Object, McpSchema.JSONRPCResponse.JSONRPCError) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse
Creates an instance of a JSONRPCResponse record class.
JsonSchema(String, Map<String, Object>, List<String>, Boolean, Map<String, Object>, Map<String, Object>) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.JsonSchema
Creates an instance of a JsonSchema record class.

L

LATEST_PROTOCOL_VERSION - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
level() - Method in enum class io.modelcontextprotocol.spec.McpSchema.LoggingLevel
 
level() - Method in record class io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification
Returns the value of the level record component.
level() - Method in record class io.modelcontextprotocol.spec.McpSchema.SetLevelRequest
Returns the value of the level record component.
level(McpSchema.LoggingLevel) - Method in class io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification.Builder
 
listChanged() - Method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.RootCapabilities
Returns the value of the listChanged record component.
listChanged() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.PromptCapabilities
Returns the value of the listChanged record component.
listChanged() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.ResourceCapabilities
Returns the value of the listChanged record component.
listChanged() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.ToolCapabilities
Returns the value of the listChanged record component.
listPrompts() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Retrieves the list of all prompts provided by the server.
listPrompts() - Method in class io.modelcontextprotocol.client.McpSyncClient
 
listPrompts(String) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Retrieves a paginated list of prompts provided by the server.
listPrompts(String) - Method in class io.modelcontextprotocol.client.McpSyncClient
 
ListPromptsResult(List<McpSchema.Prompt>, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ListPromptsResult
Creates an instance of a ListPromptsResult record class.
listResources() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Retrieves the list of all resources provided by the server.
listResources() - Method in class io.modelcontextprotocol.client.McpSyncClient
Send a resources/list request.
listResources(String) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Retrieves a paginated list of resources provided by the server.
listResources(String) - Method in class io.modelcontextprotocol.client.McpSyncClient
Send a resources/list request.
ListResourcesResult(List<McpSchema.Resource>, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ListResourcesResult
Creates an instance of a ListResourcesResult record class.
listResourceTemplates() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Retrieves the list of all resource templates provided by the server.
listResourceTemplates() - Method in class io.modelcontextprotocol.client.McpSyncClient
Request a list of resource templates the server has.
listResourceTemplates(String) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Retrieves a paginated list of resource templates provided by the server.
listResourceTemplates(String) - Method in class io.modelcontextprotocol.client.McpSyncClient
Resource templates allow servers to expose parameterized resources using URI templates.
ListResourceTemplatesResult(List<McpSchema.ResourceTemplate>, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ListResourceTemplatesResult
Creates an instance of a ListResourceTemplatesResult record class.
listRoots() - Method in class io.modelcontextprotocol.server.McpAsyncServerExchange
Retrieves the list of all roots provided by the client.
listRoots() - Method in class io.modelcontextprotocol.server.McpSyncServerExchange
Retrieves the list of all roots provided by the client.
listRoots(String) - Method in class io.modelcontextprotocol.server.McpAsyncServerExchange
Retrieves a paginated list of roots provided by the client.
listRoots(String) - Method in class io.modelcontextprotocol.server.McpSyncServerExchange
Retrieves a paginated list of roots provided by the client.
ListRootsResult(List<McpSchema.Root>) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ListRootsResult
Creates an instance of a ListRootsResult record class.
listTools() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Retrieves the list of all tools provided by the server.
listTools() - Method in class io.modelcontextprotocol.client.McpSyncClient
Retrieves the list of all tools provided by the server.
listTools(String) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Retrieves a paginated list of tools provided by the server.
listTools(String) - Method in class io.modelcontextprotocol.client.McpSyncClient
Retrieves a paginated list of tools provided by the server.
ListToolsResult(List<McpSchema.Tool>, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ListToolsResult
Creates an instance of a ListToolsResult record class.
logger() - Method in record class io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification
Returns the value of the logger record component.
logger(String) - Method in class io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification.Builder
 
logging() - Method in class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.Builder
 
logging() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities
Returns the value of the logging record component.
LoggingCapabilities() - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.LoggingCapabilities
Creates an instance of a LoggingCapabilities record class.
loggingConsumer(Consumer<McpSchema.LoggingMessageNotification>) - Method in class io.modelcontextprotocol.client.McpClient.SyncSpec
Adds a consumer to be notified when logging messages are received from the server.
loggingConsumer(Function<McpSchema.LoggingMessageNotification, Mono<Void>>) - Method in class io.modelcontextprotocol.client.McpClient.AsyncSpec
Adds a consumer to be notified when logging messages are received from the server.
loggingConsumers(List<Consumer<McpSchema.LoggingMessageNotification>>) - Method in class io.modelcontextprotocol.client.McpClient.SyncSpec
Adds multiple consumers to be notified when logging messages are received from the server.
loggingConsumers(List<Function<McpSchema.LoggingMessageNotification, Mono<Void>>>) - Method in class io.modelcontextprotocol.client.McpClient.AsyncSpec
Adds multiple consumers to be notified when logging messages are received from the server.
LoggingMessageNotification(McpSchema.LoggingLevel, String, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification
Creates an instance of a LoggingMessageNotification record class.
loggingNotification(McpSchema.LoggingMessageNotification) - Method in class io.modelcontextprotocol.server.McpAsyncServer
loggingNotification(McpSchema.LoggingMessageNotification) - Method in class io.modelcontextprotocol.server.McpAsyncServerExchange
Send a logging message notification to all connected clients.
loggingNotification(McpSchema.LoggingMessageNotification) - Method in class io.modelcontextprotocol.server.McpSyncServer
loggingNotification(McpSchema.LoggingMessageNotification) - Method in class io.modelcontextprotocol.server.McpSyncServerExchange
Send a logging message notification to all connected clients.

M

matches(String) - Method in class io.modelcontextprotocol.util.DefaultMcpUriTemplateManager
Check if a URI matches the uriTemplate with variables.
matches(String) - Method in interface io.modelcontextprotocol.util.McpUriTemplateManager
Indicate whether the given URI matches this template.
MAX_TOKENS - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult.StopReason
 
maxTokens() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest
Returns the value of the maxTokens record component.
maxTokens(int) - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.Builder
 
McpAsyncClient - Class in io.modelcontextprotocol.client
The Model Context Protocol (MCP) client implementation that provides asynchronous communication with MCP servers using Project Reactor's Mono and Flux types.
McpAsyncServer - Class in io.modelcontextprotocol.server
The Model Context Protocol (MCP) server implementation that provides asynchronous communication using Project Reactor's Mono and Flux types.
McpAsyncServerExchange - Class in io.modelcontextprotocol.server
Represents an asynchronous exchange with a Model Context Protocol (MCP) client.
McpAsyncServerExchange(McpServerSession, McpSchema.ClientCapabilities, McpSchema.Implementation) - Constructor for class io.modelcontextprotocol.server.McpAsyncServerExchange
Create a new asynchronous exchange with the client.
McpClient - Interface in io.modelcontextprotocol.client
Factory class for creating Model Context Protocol (MCP) clients.
McpClient.AsyncSpec - Class in io.modelcontextprotocol.client
Asynchronous client specification.
McpClient.SyncSpec - Class in io.modelcontextprotocol.client
Synchronous client specification.
McpClientSession - Class in io.modelcontextprotocol.spec
Default implementation of the MCP (Model Context Protocol) session that manages bidirectional JSON-RPC communication between clients and servers.
McpClientSession(Duration, McpClientTransport, Map<String, McpClientSession.RequestHandler<?>>, Map<String, McpClientSession.NotificationHandler>) - Constructor for class io.modelcontextprotocol.spec.McpClientSession
Creates a new McpClientSession with the specified configuration and handlers.
McpClientSession.NotificationHandler - Interface in io.modelcontextprotocol.spec
Functional interface for handling incoming JSON-RPC notifications.
McpClientSession.RequestHandler<T> - Interface in io.modelcontextprotocol.spec
Functional interface for handling incoming JSON-RPC requests.
McpClientTransport - Interface in io.modelcontextprotocol.spec
Marker interface for the client-side MCP transport.
McpError - Exception in io.modelcontextprotocol.spec
 
McpError(McpSchema.JSONRPCResponse.JSONRPCError) - Constructor for exception io.modelcontextprotocol.spec.McpError
 
McpError(Object) - Constructor for exception io.modelcontextprotocol.spec.McpError
 
McpSchema - Class in io.modelcontextprotocol.spec
McpSchema.Annotated - Interface in io.modelcontextprotocol.spec
Base for objects that include optional annotations for the client.
McpSchema.Annotations - Record Class in io.modelcontextprotocol.spec
Optional annotations for the client.
McpSchema.BlobResourceContents - Record Class in io.modelcontextprotocol.spec
Binary contents of a resource.
McpSchema.CallToolRequest - Record Class in io.modelcontextprotocol.spec
Used by the client to call a tool provided by the server.
McpSchema.CallToolResult - Record Class in io.modelcontextprotocol.spec
The server's response to a tools/call request from the client.
McpSchema.CallToolResult.Builder - Class in io.modelcontextprotocol.spec
McpSchema.ClientCapabilities - Record Class in io.modelcontextprotocol.spec
Clients can implement additional features to enrich connected MCP servers with additional capabilities.
McpSchema.ClientCapabilities.Builder - Class in io.modelcontextprotocol.spec
 
McpSchema.ClientCapabilities.RootCapabilities - Record Class in io.modelcontextprotocol.spec
Roots define the boundaries of where servers can operate within the filesystem, allowing them to understand which directories and files they have access to.
McpSchema.ClientCapabilities.Sampling - Record Class in io.modelcontextprotocol.spec
Provides a standardized way for servers to request LLM sampling ("completions" or "generations") from language models via clients.
McpSchema.CompleteReference - Interface in io.modelcontextprotocol.spec
 
McpSchema.CompleteRequest - Record Class in io.modelcontextprotocol.spec
 
McpSchema.CompleteRequest.CompleteArgument - Record Class in io.modelcontextprotocol.spec
 
McpSchema.CompleteResult - Record Class in io.modelcontextprotocol.spec
 
McpSchema.CompleteResult.CompleteCompletion - Record Class in io.modelcontextprotocol.spec
 
McpSchema.Content - Interface in io.modelcontextprotocol.spec
 
McpSchema.CreateMessageRequest - Record Class in io.modelcontextprotocol.spec
 
McpSchema.CreateMessageRequest.Builder - Class in io.modelcontextprotocol.spec
 
McpSchema.CreateMessageRequest.ContextInclusionStrategy - Enum Class in io.modelcontextprotocol.spec
 
McpSchema.CreateMessageResult - Record Class in io.modelcontextprotocol.spec
 
McpSchema.CreateMessageResult.Builder - Class in io.modelcontextprotocol.spec
 
McpSchema.CreateMessageResult.StopReason - Enum Class in io.modelcontextprotocol.spec
 
McpSchema.EmbeddedResource - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ErrorCodes - Class in io.modelcontextprotocol.spec
Standard error codes used in MCP JSON-RPC responses.
McpSchema.GetPromptRequest - Record Class in io.modelcontextprotocol.spec
Used by the client to get a prompt provided by the server.
McpSchema.GetPromptResult - Record Class in io.modelcontextprotocol.spec
The server's response to a prompts/get request from the client.
McpSchema.ImageContent - Record Class in io.modelcontextprotocol.spec
 
McpSchema.Implementation - Record Class in io.modelcontextprotocol.spec
 
McpSchema.InitializeRequest - Record Class in io.modelcontextprotocol.spec
 
McpSchema.InitializeResult - Record Class in io.modelcontextprotocol.spec
 
McpSchema.JSONRPCMessage - Interface in io.modelcontextprotocol.spec
 
McpSchema.JSONRPCNotification - Record Class in io.modelcontextprotocol.spec
 
McpSchema.JSONRPCRequest - Record Class in io.modelcontextprotocol.spec
 
McpSchema.JSONRPCResponse - Record Class in io.modelcontextprotocol.spec
 
McpSchema.JSONRPCResponse.JSONRPCError - Record Class in io.modelcontextprotocol.spec
 
McpSchema.JsonSchema - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ListPromptsResult - Record Class in io.modelcontextprotocol.spec
The server's response to a prompts/list request from the client.
McpSchema.ListResourcesResult - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ListResourceTemplatesResult - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ListRootsResult - Record Class in io.modelcontextprotocol.spec
The client's response to a roots/list request from the server.
McpSchema.ListToolsResult - Record Class in io.modelcontextprotocol.spec
The server's response to a tools/list request from the client.
McpSchema.LoggingLevel - Enum Class in io.modelcontextprotocol.spec
 
McpSchema.LoggingMessageNotification - Record Class in io.modelcontextprotocol.spec
The Model Context Protocol (MCP) provides a standardized way for servers to send structured log messages to clients.
McpSchema.LoggingMessageNotification.Builder - Class in io.modelcontextprotocol.spec
 
McpSchema.ModelHint - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ModelPreferences - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ModelPreferences.Builder - Class in io.modelcontextprotocol.spec
 
McpSchema.PaginatedRequest - Record Class in io.modelcontextprotocol.spec
 
McpSchema.PaginatedResult - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ProgressNotification - Record Class in io.modelcontextprotocol.spec
 
McpSchema.Prompt - Record Class in io.modelcontextprotocol.spec
A prompt or prompt template that the server offers.
McpSchema.PromptArgument - Record Class in io.modelcontextprotocol.spec
Describes an argument that a prompt can accept.
McpSchema.PromptMessage - Record Class in io.modelcontextprotocol.spec
Describes a message returned as part of a prompt.
McpSchema.PromptReference - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ReadResourceRequest - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ReadResourceResult - Record Class in io.modelcontextprotocol.spec
 
McpSchema.Request - Interface in io.modelcontextprotocol.spec
 
McpSchema.Resource - Record Class in io.modelcontextprotocol.spec
A known resource that the server is capable of reading.
McpSchema.ResourceContents - Interface in io.modelcontextprotocol.spec
The contents of a specific resource or sub-resource.
McpSchema.ResourceReference - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ResourceTemplate - Record Class in io.modelcontextprotocol.spec
Resource templates allow servers to expose parameterized resources using URI templates.
McpSchema.Role - Enum Class in io.modelcontextprotocol.spec
 
McpSchema.Root - Record Class in io.modelcontextprotocol.spec
Represents a root directory or file that the server can operate on.
McpSchema.SamplingMessage - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ServerCapabilities - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ServerCapabilities.Builder - Class in io.modelcontextprotocol.spec
 
McpSchema.ServerCapabilities.CompletionCapabilities - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ServerCapabilities.LoggingCapabilities - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ServerCapabilities.PromptCapabilities - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ServerCapabilities.ResourceCapabilities - Record Class in io.modelcontextprotocol.spec
 
McpSchema.ServerCapabilities.ToolCapabilities - Record Class in io.modelcontextprotocol.spec
 
McpSchema.SetLevelRequest - Record Class in io.modelcontextprotocol.spec
 
McpSchema.SubscribeRequest - Record Class in io.modelcontextprotocol.spec
Sent from the client to request resources/updated notifications from the server whenever a particular resource changes.
McpSchema.TextContent - Record Class in io.modelcontextprotocol.spec
 
McpSchema.TextResourceContents - Record Class in io.modelcontextprotocol.spec
Text contents of a resource.
McpSchema.Tool - Record Class in io.modelcontextprotocol.spec
Represents a tool that the server provides.
McpSchema.UnsubscribeRequest - Record Class in io.modelcontextprotocol.spec
 
McpServer - Interface in io.modelcontextprotocol.server
Factory class for creating Model Context Protocol (MCP) servers.
McpServer.AsyncSpecification - Class in io.modelcontextprotocol.server
Asynchronous server specification.
McpServer.SyncSpecification - Class in io.modelcontextprotocol.server
Synchronous server specification.
McpServerFeatures - Class in io.modelcontextprotocol.server
MCP server features specification that a particular server can choose to support.
McpServerFeatures() - Constructor for class io.modelcontextprotocol.server.McpServerFeatures
 
McpServerFeatures.AsyncCompletionSpecification - Record Class in io.modelcontextprotocol.server
Specification of a completion handler function with asynchronous execution support.
McpServerFeatures.AsyncPromptSpecification - Record Class in io.modelcontextprotocol.server
Specification of a prompt template with its asynchronous handler function.
McpServerFeatures.AsyncResourceSpecification - Record Class in io.modelcontextprotocol.server
Specification of a resource with its asynchronous handler function.
McpServerFeatures.AsyncToolSpecification - Record Class in io.modelcontextprotocol.server
Specification of a tool with its asynchronous handler function.
McpServerFeatures.SyncCompletionSpecification - Record Class in io.modelcontextprotocol.server
Specification of a completion handler function with synchronous execution support.
McpServerFeatures.SyncPromptSpecification - Record Class in io.modelcontextprotocol.server
Specification of a prompt template with its synchronous handler function.
McpServerFeatures.SyncResourceSpecification - Record Class in io.modelcontextprotocol.server
Specification of a resource with its synchronous handler function.
McpServerFeatures.SyncToolSpecification - Record Class in io.modelcontextprotocol.server
Specification of a tool with its synchronous handler function.
McpServerSession - Class in io.modelcontextprotocol.spec
Represents a Model Control Protocol (MCP) session on the server side.
McpServerSession(String, Duration, McpServerTransport, McpServerSession.InitRequestHandler, McpServerSession.InitNotificationHandler, Map<String, McpServerSession.RequestHandler<?>>, Map<String, McpServerSession.NotificationHandler>) - Constructor for class io.modelcontextprotocol.spec.McpServerSession
Creates a new server session with the given parameters and the transport to use.
McpServerSession.Factory - Interface in io.modelcontextprotocol.spec
Factory for creating server sessions which delegate to a provided 1:1 transport with a connected client.
McpServerSession.InitNotificationHandler - Interface in io.modelcontextprotocol.spec
Notification handler for the initialization notification from the client.
McpServerSession.InitRequestHandler - Interface in io.modelcontextprotocol.spec
Request handler for the initialization request.
McpServerSession.NotificationHandler - Interface in io.modelcontextprotocol.spec
A handler for client-initiated notifications.
McpServerSession.RequestHandler<T> - Interface in io.modelcontextprotocol.spec
A handler for client-initiated requests.
McpServerTransport - Interface in io.modelcontextprotocol.spec
Marker interface for the server-side MCP transport.
McpServerTransportProvider - Interface in io.modelcontextprotocol.spec
The core building block providing the server-side MCP transport.
McpSession - Interface in io.modelcontextprotocol.spec
Represents a Model Control Protocol (MCP) session that handles communication between clients and the server.
McpSyncClient - Class in io.modelcontextprotocol.client
A synchronous client implementation for the Model Context Protocol (MCP) that wraps an McpAsyncClient to provide blocking operations.
McpSyncServer - Class in io.modelcontextprotocol.server
A synchronous implementation of the Model Context Protocol (MCP) server that wraps McpAsyncServer to provide blocking operations.
McpSyncServer(McpAsyncServer) - Constructor for class io.modelcontextprotocol.server.McpSyncServer
Creates a new synchronous server that wraps the provided async server.
McpSyncServerExchange - Class in io.modelcontextprotocol.server
Represents a synchronous exchange with a Model Context Protocol (MCP) client.
McpSyncServerExchange(McpAsyncServerExchange) - Constructor for class io.modelcontextprotocol.server.McpSyncServerExchange
Create a new synchronous exchange with the client using the provided asynchronous implementation as a delegate.
McpTransport - Interface in io.modelcontextprotocol.spec
Defines the asynchronous transport layer for the Model Context Protocol (MCP).
McpUriTemplateManager - Interface in io.modelcontextprotocol.util
Interface for working with URI templates.
McpUriTemplateManagerFactory - Interface in io.modelcontextprotocol.util
Factory interface for creating instances of McpUriTemplateManager.
message() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse.JSONRPCError
Returns the value of the message record component.
message(String) - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult.Builder
 
MESSAGE_EVENT_TYPE - Static variable in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
Event type for regular messages
messageEndpoint(String) - Method in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider.Builder
Sets the endpoint path where clients will send their messages.
messages() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest
Returns the value of the messages record component.
messages() - Method in record class io.modelcontextprotocol.spec.McpSchema.GetPromptResult
Returns the value of the messages record component.
messages(List<McpSchema.SamplingMessage>) - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.Builder
 
metadata() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest
Returns the value of the metadata record component.
metadata(Map<String, Object>) - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.Builder
 
method() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCNotification
Returns the value of the method record component.
method() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCRequest
Returns the value of the method record component.
METHOD_COMPLETION_COMPLETE - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_INITIALIZE - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_LOGGING_SET_LEVEL - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_NOT_FOUND - Static variable in class io.modelcontextprotocol.spec.McpSchema.ErrorCodes
The method does not exist / is not available.
METHOD_NOTIFICATION_INITIALIZED - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_NOTIFICATION_MESSAGE - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_NOTIFICATION_PROMPTS_LIST_CHANGED - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_NOTIFICATION_RESOURCES_LIST_CHANGED - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_NOTIFICATION_ROOTS_LIST_CHANGED - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_NOTIFICATION_TOOLS_LIST_CHANGED - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_PING - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_PROMPT_GET - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_PROMPT_LIST - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_RESOURCES_LIST - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_RESOURCES_READ - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_RESOURCES_SUBSCRIBE - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_RESOURCES_TEMPLATES_LIST - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_RESOURCES_UNSUBSCRIBE - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_ROOTS_LIST - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_SAMPLING_CREATE_MESSAGE - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_TOOLS_CALL - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
METHOD_TOOLS_LIST - Static variable in class io.modelcontextprotocol.spec.McpSchema
 
mimeType() - Method in record class io.modelcontextprotocol.spec.McpSchema.BlobResourceContents
Returns the value of the mimeType record component.
mimeType() - Method in record class io.modelcontextprotocol.spec.McpSchema.ImageContent
Returns the value of the mimeType record component.
mimeType() - Method in record class io.modelcontextprotocol.spec.McpSchema.Resource
Returns the value of the mimeType record component.
mimeType() - Method in interface io.modelcontextprotocol.spec.McpSchema.ResourceContents
The MIME type of this resource.
mimeType() - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceTemplate
Returns the value of the mimeType record component.
mimeType() - Method in record class io.modelcontextprotocol.spec.McpSchema.TextResourceContents
Returns the value of the mimeType record component.
model() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult
Returns the value of the model record component.
model(String) - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult.Builder
 
ModelHint(String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ModelHint
Creates an instance of a ModelHint record class.
modelPreferences() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest
Returns the value of the modelPreferences record component.
modelPreferences(McpSchema.ModelPreferences) - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.Builder
 
ModelPreferences(List<McpSchema.ModelHint>, Double, Double, Double) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ModelPreferences
Creates an instance of a ModelPreferences record class.

N

name() - Method in record class io.modelcontextprotocol.spec.McpSchema.CallToolRequest
Returns the value of the name record component.
name() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteRequest.CompleteArgument
Returns the value of the name record component.
name() - Method in record class io.modelcontextprotocol.spec.McpSchema.GetPromptRequest
Returns the value of the name record component.
name() - Method in record class io.modelcontextprotocol.spec.McpSchema.Implementation
Returns the value of the name record component.
name() - Method in record class io.modelcontextprotocol.spec.McpSchema.ModelHint
Returns the value of the name record component.
name() - Method in record class io.modelcontextprotocol.spec.McpSchema.Prompt
Returns the value of the name record component.
name() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptArgument
Returns the value of the name record component.
name() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptReference
Returns the value of the name record component.
name() - Method in record class io.modelcontextprotocol.spec.McpSchema.Resource
Returns the value of the name record component.
name() - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceTemplate
Returns the value of the name record component.
name() - Method in record class io.modelcontextprotocol.spec.McpSchema.Root
Returns the value of the name record component.
name() - Method in record class io.modelcontextprotocol.spec.McpSchema.Tool
Returns the value of the name record component.
nextCursor() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListPromptsResult
Returns the value of the nextCursor record component.
nextCursor() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListResourcesResult
Returns the value of the nextCursor record component.
nextCursor() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListResourceTemplatesResult
Returns the value of the nextCursor record component.
nextCursor() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListToolsResult
Returns the value of the nextCursor record component.
nextCursor() - Method in record class io.modelcontextprotocol.spec.McpSchema.PaginatedResult
Returns the value of the nextCursor record component.
NONE - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.ContextInclusionStrategy
 
notEmpty(Collection<?>, String) - Static method in class io.modelcontextprotocol.util.Assert
Assert that the collection is not null and not empty.
NOTICE - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.LoggingLevel
 
notifyClients(String, Object) - Method in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
Broadcasts a notification to all connected clients.
notifyClients(String, Object) - Method in class io.modelcontextprotocol.server.transport.StdioServerTransportProvider
 
notifyClients(String, Object) - Method in interface io.modelcontextprotocol.spec.McpServerTransportProvider
Sends a notification to all connected clients.
notifyPromptsListChanged() - Method in class io.modelcontextprotocol.server.McpAsyncServer
Notifies clients that the list of available prompts has changed.
notifyPromptsListChanged() - Method in class io.modelcontextprotocol.server.McpSyncServer
Notify clients that the list of available prompts has changed.
notifyResourcesListChanged() - Method in class io.modelcontextprotocol.server.McpAsyncServer
Notifies clients that the list of available resources has changed.
notifyResourcesListChanged() - Method in class io.modelcontextprotocol.server.McpSyncServer
Notify clients that the list of available resources has changed.
notifyToolsListChanged() - Method in class io.modelcontextprotocol.server.McpAsyncServer
Notifies clients that the list of available tools has changed.
notifyToolsListChanged() - Method in class io.modelcontextprotocol.server.McpSyncServer
Notify clients that the list of available tools has changed.
notNull(Object, String) - Static method in class io.modelcontextprotocol.util.Assert
Assert that an object is not null.

O

objectMapper - Variable in class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport
JSON object mapper for message serialization/deserialization
objectMapper(ObjectMapper) - Method in class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport.Builder
Sets the object mapper for JSON serialization/deserialization.
objectMapper(ObjectMapper) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Sets the object mapper to use for serializing and deserializing JSON messages.
objectMapper(ObjectMapper) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Sets the object mapper to use for serializing and deserializing JSON messages.
objectMapper(ObjectMapper) - Method in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider.Builder
Sets the JSON object mapper to use for message serialization/deserialization.
of(String) - Static method in record class io.modelcontextprotocol.spec.McpSchema.ModelHint
 
onError(Throwable) - Method in interface io.modelcontextprotocol.client.transport.FlowSseClient.SseEventHandler
Called when an error occurs during the SSE connection.
onEvent(FlowSseClient.SseEvent) - Method in interface io.modelcontextprotocol.client.transport.FlowSseClient.SseEventHandler
Called when an SSE event is received.

P

PaginatedRequest(String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.PaginatedRequest
Creates an instance of a PaginatedRequest record class.
PaginatedResult(String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.PaginatedResult
Creates an instance of a PaginatedResult record class.
params() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCNotification
Returns the value of the params record component.
params() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCRequest
Returns the value of the params record component.
PARSE_ERROR - Static variable in class io.modelcontextprotocol.spec.McpSchema.ErrorCodes
Invalid JSON was received by the server.
ping() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Sends a ping request to the server.
ping() - Method in class io.modelcontextprotocol.client.McpSyncClient
Send a synchronous ping request.
priority() - Method in record class io.modelcontextprotocol.spec.McpSchema.Annotations
Returns the value of the priority record component.
priority() - Method in record class io.modelcontextprotocol.spec.McpSchema.EmbeddedResource
Returns the value of the priority record component.
priority() - Method in record class io.modelcontextprotocol.spec.McpSchema.ImageContent
Returns the value of the priority record component.
priority() - Method in record class io.modelcontextprotocol.spec.McpSchema.TextContent
Returns the value of the priority record component.
progress() - Method in record class io.modelcontextprotocol.spec.McpSchema.ProgressNotification
Returns the value of the progress record component.
ProgressNotification(String, double, Double) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ProgressNotification
Creates an instance of a ProgressNotification record class.
progressToken() - Method in record class io.modelcontextprotocol.spec.McpSchema.ProgressNotification
Returns the value of the progressToken record component.
prompt() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncPromptSpecification
Returns the value of the prompt record component.
prompt() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncPromptSpecification
Returns the value of the prompt record component.
Prompt(String, String, List<McpSchema.PromptArgument>) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.Prompt
Creates an instance of a Prompt record class.
PromptArgument(String, String, Boolean) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.PromptArgument
Creates an instance of a PromptArgument record class.
PromptCapabilities(Boolean) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.PromptCapabilities
Creates an instance of a PromptCapabilities record class.
promptHandler() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncPromptSpecification
Returns the value of the promptHandler record component.
promptHandler() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncPromptSpecification
Returns the value of the promptHandler record component.
PromptMessage(McpSchema.Role, McpSchema.Content) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.PromptMessage
Creates an instance of a PromptMessage record class.
PromptReference(String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.PromptReference
 
PromptReference(String, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.PromptReference
Creates an instance of a PromptReference record class.
prompts() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListPromptsResult
Returns the value of the prompts record component.
prompts() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities
Returns the value of the prompts record component.
prompts(McpServerFeatures.AsyncPromptSpecification...) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Registers multiple prompts with their handlers using varargs.
prompts(McpServerFeatures.SyncPromptSpecification...) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Registers multiple prompts with their handlers using varargs.
prompts(Boolean) - Method in class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.Builder
 
prompts(List<McpServerFeatures.AsyncPromptSpecification>) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Registers multiple prompts with their handlers using a List.
prompts(List<McpServerFeatures.SyncPromptSpecification>) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Registers multiple prompts with their handlers using a List.
prompts(Map<String, McpServerFeatures.AsyncPromptSpecification>) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Registers multiple prompts with their handlers using a Map.
prompts(Map<String, McpServerFeatures.SyncPromptSpecification>) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Registers multiple prompts with their handlers using a Map.
promptsChangeConsumer(Consumer<List<McpSchema.Prompt>>) - Method in class io.modelcontextprotocol.client.McpClient.SyncSpec
Adds a consumer to be notified when the available prompts change.
promptsChangeConsumer(Function<List<McpSchema.Prompt>, Mono<Void>>) - Method in class io.modelcontextprotocol.client.McpClient.AsyncSpec
Adds a consumer to be notified when the available prompts change.
properties() - Method in record class io.modelcontextprotocol.spec.McpSchema.JsonSchema
Returns the value of the properties record component.
protocolVersion() - Method in record class io.modelcontextprotocol.spec.McpSchema.InitializeRequest
Returns the value of the protocolVersion record component.
protocolVersion() - Method in record class io.modelcontextprotocol.spec.McpSchema.InitializeResult
Returns the value of the protocolVersion record component.

R

readHandler() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncResourceSpecification
Returns the value of the readHandler record component.
readHandler() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncResourceSpecification
Returns the value of the readHandler record component.
readResource(McpSchema.ReadResourceRequest) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Reads the content of a specific resource identified by the provided request.
readResource(McpSchema.ReadResourceRequest) - Method in class io.modelcontextprotocol.client.McpSyncClient
Send a resources/read request.
readResource(McpSchema.Resource) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Reads the content of a specific resource identified by the provided Resource object.
readResource(McpSchema.Resource) - Method in class io.modelcontextprotocol.client.McpSyncClient
Send a resources/read request.
ReadResourceRequest(String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ReadResourceRequest
Creates an instance of a ReadResourceRequest record class.
ReadResourceResult(List<McpSchema.ResourceContents>) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ReadResourceResult
Creates an instance of a ReadResourceResult record class.
ref() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteRequest
Returns the value of the ref record component.
referenceKey() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncCompletionSpecification
Returns the value of the referenceKey record component.
referenceKey() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncCompletionSpecification
Returns the value of the referenceKey record component.
removePrompt(String) - Method in class io.modelcontextprotocol.server.McpAsyncServer
Remove a prompt handler at runtime.
removePrompt(String) - Method in class io.modelcontextprotocol.server.McpSyncServer
Remove a prompt handler.
removeResource(String) - Method in class io.modelcontextprotocol.server.McpAsyncServer
Remove a resource handler at runtime.
removeResource(String) - Method in class io.modelcontextprotocol.server.McpSyncServer
Remove a resource handler.
removeRoot(String) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Removes a root from the client's root list.
removeRoot(String) - Method in class io.modelcontextprotocol.client.McpSyncClient
Remove a root dynamically.
removeTool(String) - Method in class io.modelcontextprotocol.server.McpAsyncServer
Remove a tool handler at runtime.
removeTool(String) - Method in class io.modelcontextprotocol.server.McpSyncServer
Remove a tool handler.
requestBuilder(HttpRequest.Builder) - Method in class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport.Builder
Sets the HTTP request builder.
requestTimeout(Duration) - Method in class io.modelcontextprotocol.client.McpClient.AsyncSpec
Sets the duration to wait for server responses before timing out requests.
requestTimeout(Duration) - Method in class io.modelcontextprotocol.client.McpClient.SyncSpec
Sets the duration to wait for server responses before timing out requests.
requestTimeout(Duration) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Sets the duration to wait for server responses before timing out requests.
requestTimeout(Duration) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Sets the duration to wait for server responses before timing out requests.
required() - Method in record class io.modelcontextprotocol.spec.McpSchema.JsonSchema
Returns the value of the required record component.
required() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptArgument
Returns the value of the required record component.
resolveUri(URI, String) - Static method in class io.modelcontextprotocol.util.Utils
Resolves the given endpoint URL against the base URL.
resource() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncResourceSpecification
Returns the value of the resource record component.
resource() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncResourceSpecification
Returns the value of the resource record component.
resource() - Method in record class io.modelcontextprotocol.spec.McpSchema.EmbeddedResource
Returns the value of the resource record component.
Resource(String, String, String, String, McpSchema.Annotations) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.Resource
Creates an instance of a Resource record class.
ResourceCapabilities(Boolean, Boolean) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.ResourceCapabilities
Creates an instance of a ResourceCapabilities record class.
ResourceReference(String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ResourceReference
 
ResourceReference(String, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ResourceReference
Creates an instance of a ResourceReference record class.
resources() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListResourcesResult
Returns the value of the resources record component.
resources() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities
Returns the value of the resources record component.
resources(McpServerFeatures.AsyncResourceSpecification...) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Registers multiple resources with their handlers using varargs.
resources(McpServerFeatures.SyncResourceSpecification...) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Registers multiple resources with their handlers using varargs.
resources(Boolean, Boolean) - Method in class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.Builder
 
resources(List<McpServerFeatures.AsyncResourceSpecification>) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Registers multiple resources with their handlers using a List.
resources(List<McpServerFeatures.SyncResourceSpecification>) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Registers multiple resources with their handlers using a List.
resources(Map<String, McpServerFeatures.AsyncResourceSpecification>) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Registers multiple resources with their handlers using a Map.
resources(Map<String, McpServerFeatures.SyncResourceSpecification>) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Registers multiple resources with their handlers using a Map.
resourcesChangeConsumer(Consumer<List<McpSchema.Resource>>) - Method in class io.modelcontextprotocol.client.McpClient.SyncSpec
Adds a consumer to be notified when the available resources change.
resourcesChangeConsumer(Function<List<McpSchema.Resource>, Mono<Void>>) - Method in class io.modelcontextprotocol.client.McpClient.AsyncSpec
Adds a consumer to be notified when the available resources change.
ResourceTemplate(String, String, String, String, McpSchema.Annotations) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ResourceTemplate
Creates an instance of a ResourceTemplate record class.
resourceTemplates() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListResourceTemplatesResult
Returns the value of the resourceTemplates record component.
resourceTemplates(McpSchema.ResourceTemplate...) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Sets the resource templates using varargs for convenience.
resourceTemplates(McpSchema.ResourceTemplate...) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Sets the resource templates using varargs for convenience.
resourceTemplates(List<McpSchema.ResourceTemplate>) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Sets the resource templates that define patterns for dynamic resource access.
resourceTemplates(List<McpSchema.ResourceTemplate>) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Sets the resource templates that define patterns for dynamic resource access.
result() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse
Returns the value of the result record component.
role() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult
Returns the value of the role record component.
role() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptMessage
Returns the value of the role record component.
role() - Method in record class io.modelcontextprotocol.spec.McpSchema.SamplingMessage
Returns the value of the role record component.
role(McpSchema.Role) - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult.Builder
 
Root(String, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.Root
Creates an instance of a Root record class.
RootCapabilities(Boolean) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.RootCapabilities
Creates an instance of a RootCapabilities record class.
roots() - Method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities
Returns the value of the roots record component.
roots() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListRootsResult
Returns the value of the roots record component.
roots(McpSchema.Root...) - Method in class io.modelcontextprotocol.client.McpClient.AsyncSpec
Sets the root URIs that this client can access, using a varargs parameter for convenience.
roots(McpSchema.Root...) - Method in class io.modelcontextprotocol.client.McpClient.SyncSpec
Sets the root URIs that this client can access, using a varargs parameter for convenience.
roots(Boolean) - Method in class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.Builder
 
roots(List<McpSchema.Root>) - Method in class io.modelcontextprotocol.client.McpClient.AsyncSpec
Sets the root URIs that this client can access.
roots(List<McpSchema.Root>) - Method in class io.modelcontextprotocol.client.McpClient.SyncSpec
Sets the root URIs that this client can access.
rootsChangeHandler(BiConsumer<McpSyncServerExchange, List<McpSchema.Root>>) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Registers a consumer that will be notified when the list of roots changes.
rootsChangeHandler(BiFunction<McpAsyncServerExchange, List<McpSchema.Root>, Mono<Void>>) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Registers a consumer that will be notified when the list of roots changes.
rootsChangeHandlers(BiConsumer<McpSyncServerExchange, List<McpSchema.Root>>...) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Registers multiple consumers that will be notified when the list of roots changes using varargs.
rootsChangeHandlers(BiFunction<McpAsyncServerExchange, List<McpSchema.Root>, Mono<Void>>...) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Registers multiple consumers that will be notified when the list of roots changes using varargs.
rootsChangeHandlers(List<BiConsumer<McpSyncServerExchange, List<McpSchema.Root>>>) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Registers multiple consumers that will be notified when the list of roots changes.
rootsChangeHandlers(List<BiFunction<McpAsyncServerExchange, List<McpSchema.Root>, Mono<Void>>>) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Registers multiple consumers that will be notified when the list of roots changes.
rootsListChangedNotification() - Method in class io.modelcontextprotocol.client.McpAsyncClient
Manually sends a roots/list_changed notification.
rootsListChangedNotification() - Method in class io.modelcontextprotocol.client.McpSyncClient
Send a roots/list_changed notification.

S

sampling() - Method in class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.Builder
 
sampling() - Method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities
Returns the value of the sampling record component.
sampling(Function<McpSchema.CreateMessageRequest, McpSchema.CreateMessageResult>) - Method in class io.modelcontextprotocol.client.McpClient.SyncSpec
Sets a custom sampling handler for processing message creation requests.
sampling(Function<McpSchema.CreateMessageRequest, Mono<McpSchema.CreateMessageResult>>) - Method in class io.modelcontextprotocol.client.McpClient.AsyncSpec
Sets a custom sampling handler for processing message creation requests.
Sampling() - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.Sampling
Creates an instance of a Sampling record class.
SamplingMessage(McpSchema.Role, McpSchema.Content) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.SamplingMessage
Creates an instance of a SamplingMessage record class.
sendMessage(McpSchema.JSONRPCMessage) - Method in class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport
Sends a JSON-RPC message to the server.
sendMessage(McpSchema.JSONRPCMessage) - Method in class io.modelcontextprotocol.client.transport.StdioClientTransport
 
sendMessage(McpSchema.JSONRPCMessage) - Method in interface io.modelcontextprotocol.spec.McpTransport
Sends a message to the peer asynchronously.
sendNotification(String) - Method in interface io.modelcontextprotocol.spec.McpSession
Sends a notification to the model client or server without parameters.
sendNotification(String, Object) - Method in class io.modelcontextprotocol.spec.McpClientSession
Sends a JSON-RPC notification.
sendNotification(String, Object) - Method in class io.modelcontextprotocol.spec.McpServerSession
 
sendNotification(String, Object) - Method in interface io.modelcontextprotocol.spec.McpSession
Sends a notification to the model client or server with parameters.
sendRequest(String, Object, TypeReference<T>) - Method in class io.modelcontextprotocol.spec.McpClientSession
Sends a JSON-RPC request and returns the response.
sendRequest(String, Object, TypeReference<T>) - Method in class io.modelcontextprotocol.spec.McpServerSession
 
sendRequest(String, Object, TypeReference<T>) - Method in interface io.modelcontextprotocol.spec.McpSession
Sends a request to the model counterparty and expects a response of type T.
ServerCapabilities(McpSchema.ServerCapabilities.CompletionCapabilities, Map<String, Object>, McpSchema.ServerCapabilities.LoggingCapabilities, McpSchema.ServerCapabilities.PromptCapabilities, McpSchema.ServerCapabilities.ResourceCapabilities, McpSchema.ServerCapabilities.ToolCapabilities) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities
Creates an instance of a ServerCapabilities record class.
serverInfo() - Method in record class io.modelcontextprotocol.spec.McpSchema.InitializeResult
Returns the value of the serverInfo record component.
serverInfo(McpSchema.Implementation) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Sets the server implementation information that will be shared with clients during connection initialization.
serverInfo(McpSchema.Implementation) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Sets the server implementation information that will be shared with clients during connection initialization.
serverInfo(String, String) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Sets the server implementation information using name and version strings.
serverInfo(String, String) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Sets the server implementation information using name and version strings.
ServerParameters - Class in io.modelcontextprotocol.client.transport
Server parameters for stdio client.
ServerParameters.Builder - Class in io.modelcontextprotocol.client.transport
 
SetLevelRequest(McpSchema.LoggingLevel) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.SetLevelRequest
Creates an instance of a SetLevelRequest record class.
setLoggingLevel(McpSchema.LoggingLevel) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Sets the minimum logging level for messages received from the server.
setLoggingLevel(McpSchema.LoggingLevel) - Method in class io.modelcontextprotocol.client.McpSyncClient
Client can set the minimum logging level it wants to receive from the server.
setSessionFactory(McpServerSession.Factory) - Method in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
Sets the session factory for creating new sessions.
setSessionFactory(McpServerSession.Factory) - Method in class io.modelcontextprotocol.server.transport.StdioServerTransportProvider
 
setSessionFactory(McpServerSession.Factory) - Method in interface io.modelcontextprotocol.spec.McpServerTransportProvider
Sets the session factory that will be used to create sessions for new clients.
setStdErrorHandler(Consumer<String>) - Method in class io.modelcontextprotocol.client.transport.StdioClientTransport
Sets the handler for processing transport-level errors.
speedPriority() - Method in record class io.modelcontextprotocol.spec.McpSchema.ModelPreferences
Returns the value of the speedPriority record component.
speedPriority(Double) - Method in class io.modelcontextprotocol.spec.McpSchema.ModelPreferences.Builder
 
sseEndpoint(String) - Method in class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport.Builder
Sets the SSE endpoint path.
sseEndpoint(String) - Method in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider.Builder
Sets the endpoint path where clients will establish SSE connections.
SseEvent(String, String, String) - Constructor for record class io.modelcontextprotocol.client.transport.FlowSseClient.SseEvent
Creates an instance of a SseEvent record class.
StdioClientTransport - Class in io.modelcontextprotocol.client.transport
Implementation of the MCP Stdio transport that communicates with a server process using standard input/output streams.
StdioClientTransport(ServerParameters) - Constructor for class io.modelcontextprotocol.client.transport.StdioClientTransport
Creates a new StdioClientTransport with the specified parameters and default ObjectMapper.
StdioClientTransport(ServerParameters, ObjectMapper) - Constructor for class io.modelcontextprotocol.client.transport.StdioClientTransport
Creates a new StdioClientTransport with the specified parameters and ObjectMapper.
StdioServerTransportProvider - Class in io.modelcontextprotocol.server.transport
Implementation of the MCP Stdio transport provider for servers that communicates using standard input/output streams.
StdioServerTransportProvider() - Constructor for class io.modelcontextprotocol.server.transport.StdioServerTransportProvider
Creates a new StdioServerTransportProvider with a default ObjectMapper and System streams.
StdioServerTransportProvider(ObjectMapper) - Constructor for class io.modelcontextprotocol.server.transport.StdioServerTransportProvider
Creates a new StdioServerTransportProvider with the specified ObjectMapper and System streams.
StdioServerTransportProvider(ObjectMapper, InputStream, OutputStream) - Constructor for class io.modelcontextprotocol.server.transport.StdioServerTransportProvider
Creates a new StdioServerTransportProvider with the specified ObjectMapper and streams.
STOP_SEQUENCE - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult.StopReason
 
stopReason() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult
Returns the value of the stopReason record component.
stopReason(McpSchema.CreateMessageResult.StopReason) - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult.Builder
 
stopSequences() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest
Returns the value of the stopSequences record component.
stopSequences(List<String>) - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.Builder
 
subscribe() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.ResourceCapabilities
Returns the value of the subscribe record component.
subscribe(String, FlowSseClient.SseEventHandler) - Method in class io.modelcontextprotocol.client.transport.FlowSseClient
Subscribes to an SSE endpoint and processes the event stream.
SubscribeRequest(String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.SubscribeRequest
Creates an instance of a SubscribeRequest record class.
subscribeResource(McpSchema.SubscribeRequest) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Subscribes to changes in a specific resource.
subscribeResource(McpSchema.SubscribeRequest) - Method in class io.modelcontextprotocol.client.McpSyncClient
Subscriptions.
sync(McpClientTransport) - Static method in interface io.modelcontextprotocol.client.McpClient
Start building a synchronous MCP client with the specified transport layer.
sync(McpServerTransportProvider) - Static method in interface io.modelcontextprotocol.server.McpServer
Starts building a synchronous MCP server that provides blocking operations.
SyncCompletionSpecification(McpSchema.CompleteReference, BiFunction<McpSyncServerExchange, McpSchema.CompleteRequest, McpSchema.CompleteResult>) - Constructor for record class io.modelcontextprotocol.server.McpServerFeatures.SyncCompletionSpecification
Creates an instance of a SyncCompletionSpecification record class.
SyncPromptSpecification(McpSchema.Prompt, BiFunction<McpSyncServerExchange, McpSchema.GetPromptRequest, McpSchema.GetPromptResult>) - Constructor for record class io.modelcontextprotocol.server.McpServerFeatures.SyncPromptSpecification
Creates an instance of a SyncPromptSpecification record class.
SyncResourceSpecification(McpSchema.Resource, BiFunction<McpSyncServerExchange, McpSchema.ReadResourceRequest, McpSchema.ReadResourceResult>) - Constructor for record class io.modelcontextprotocol.server.McpServerFeatures.SyncResourceSpecification
Creates an instance of a SyncResourceSpecification record class.
SyncToolSpecification(McpSchema.Tool, BiFunction<McpSyncServerExchange, Map<String, Object>, McpSchema.CallToolResult>) - Constructor for record class io.modelcontextprotocol.server.McpServerFeatures.SyncToolSpecification
Creates an instance of a SyncToolSpecification record class.
systemPrompt() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest
Returns the value of the systemPrompt record component.
systemPrompt(String) - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.Builder
 

T

temperature() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest
Returns the value of the temperature record component.
temperature(Double) - Method in class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.Builder
 
text() - Method in record class io.modelcontextprotocol.spec.McpSchema.TextContent
Returns the value of the text record component.
text() - Method in record class io.modelcontextprotocol.spec.McpSchema.TextResourceContents
Returns the value of the text record component.
textContent(List<String>) - Method in class io.modelcontextprotocol.spec.McpSchema.CallToolResult.Builder
Sets the text content for the tool result.
TextContent(String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.TextContent
 
TextContent(List<McpSchema.Role>, Double, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.TextContent
Creates an instance of a TextContent record class.
TextResourceContents(String, String, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.TextResourceContents
Creates an instance of a TextResourceContents record class.
THIS_SERVER - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.ContextInclusionStrategy
 
tool() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncToolSpecification
Returns the value of the tool record component.
tool() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncToolSpecification
Returns the value of the tool record component.
tool(McpSchema.Tool, BiFunction<McpAsyncServerExchange, Map<String, Object>, Mono<McpSchema.CallToolResult>>) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Adds a single tool with its implementation handler to the server.
tool(McpSchema.Tool, BiFunction<McpSyncServerExchange, Map<String, Object>, McpSchema.CallToolResult>) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Adds a single tool with its implementation handler to the server.
Tool(String, String, McpSchema.JsonSchema) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.Tool
Creates an instance of a Tool record class.
Tool(String, String, String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.Tool
 
ToolCapabilities(Boolean) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.ToolCapabilities
Creates an instance of a ToolCapabilities record class.
tools() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListToolsResult
Returns the value of the tools record component.
tools() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities
Returns the value of the tools record component.
tools(McpServerFeatures.AsyncToolSpecification...) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Adds multiple tools with their handlers to the server using varargs.
tools(McpServerFeatures.SyncToolSpecification...) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Adds multiple tools with their handlers to the server using varargs.
tools(Boolean) - Method in class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.Builder
 
tools(List<McpServerFeatures.AsyncToolSpecification>) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Adds multiple tools with their handlers to the server using a List.
tools(List<McpServerFeatures.SyncToolSpecification>) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Adds multiple tools with their handlers to the server using a List.
toolsChangeConsumer(Consumer<List<McpSchema.Tool>>) - Method in class io.modelcontextprotocol.client.McpClient.SyncSpec
Adds a consumer to be notified when the available tools change.
toolsChangeConsumer(Function<List<McpSchema.Tool>, Mono<Void>>) - Method in class io.modelcontextprotocol.client.McpClient.AsyncSpec
Adds a consumer to be notified when the available tools change.
toString() - Method in record class io.modelcontextprotocol.client.transport.FlowSseClient.SseEvent
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncCompletionSpecification
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncPromptSpecification
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncResourceSpecification
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.AsyncToolSpecification
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncCompletionSpecification
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncPromptSpecification
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncResourceSpecification
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.server.McpServerFeatures.SyncToolSpecification
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.Annotations
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.BlobResourceContents
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.CallToolRequest
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.CallToolResult
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.RootCapabilities
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.Sampling
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ClientCapabilities
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteRequest.CompleteArgument
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteRequest
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteResult.CompleteCompletion
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteResult
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.EmbeddedResource
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.GetPromptRequest
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.GetPromptResult
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ImageContent
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.Implementation
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.InitializeRequest
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.InitializeResult
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCNotification
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCRequest
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse.JSONRPCError
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.JSONRPCResponse
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.JsonSchema
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListPromptsResult
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListResourcesResult
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListResourceTemplatesResult
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListRootsResult
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ListToolsResult
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.LoggingMessageNotification
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ModelHint
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ModelPreferences
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.PaginatedRequest
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.PaginatedResult
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ProgressNotification
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.Prompt
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptArgument
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptMessage
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptReference
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ReadResourceRequest
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ReadResourceResult
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.Resource
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceReference
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceTemplate
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.Root
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.SamplingMessage
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.CompletionCapabilities
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.LoggingCapabilities
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.PromptCapabilities
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.ResourceCapabilities
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities.ToolCapabilities
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.ServerCapabilities
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.SetLevelRequest
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.SubscribeRequest
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.TextContent
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.TextResourceContents
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.Tool
Returns a string representation of this record class.
toString() - Method in record class io.modelcontextprotocol.spec.McpSchema.UnsubscribeRequest
Returns a string representation of this record class.
total() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteResult.CompleteCompletion
Returns the value of the total record component.
total() - Method in record class io.modelcontextprotocol.spec.McpSchema.ProgressNotification
Returns the value of the total record component.
type() - Method in record class io.modelcontextprotocol.client.transport.FlowSseClient.SseEvent
Returns the value of the type record component.
type() - Method in interface io.modelcontextprotocol.spec.McpSchema.CompleteReference
 
type() - Method in interface io.modelcontextprotocol.spec.McpSchema.Content
 
type() - Method in record class io.modelcontextprotocol.spec.McpSchema.JsonSchema
Returns the value of the type record component.
type() - Method in record class io.modelcontextprotocol.spec.McpSchema.PromptReference
Returns the value of the type record component.
type() - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceReference
Returns the value of the type record component.

U

unmarshalFrom(Object, TypeReference<T>) - Method in class io.modelcontextprotocol.client.transport.HttpClientSseClientTransport
Unmarshal data to the specified type using the configured object mapper.
unmarshalFrom(Object, TypeReference<T>) - Method in class io.modelcontextprotocol.client.transport.StdioClientTransport
 
unmarshalFrom(Object, TypeReference<T>) - Method in interface io.modelcontextprotocol.spec.McpTransport
Unmarshals the given data into an object of the specified type.
UnsubscribeRequest(String) - Constructor for record class io.modelcontextprotocol.spec.McpSchema.UnsubscribeRequest
Creates an instance of a UnsubscribeRequest record class.
unsubscribeResource(McpSchema.UnsubscribeRequest) - Method in class io.modelcontextprotocol.client.McpAsyncClient
Cancels an existing subscription to a resource.
unsubscribeResource(McpSchema.UnsubscribeRequest) - Method in class io.modelcontextprotocol.client.McpSyncClient
Send a resources/unsubscribe request.
uri() - Method in record class io.modelcontextprotocol.spec.McpSchema.BlobResourceContents
Returns the value of the uri record component.
uri() - Method in record class io.modelcontextprotocol.spec.McpSchema.ReadResourceRequest
Returns the value of the uri record component.
uri() - Method in record class io.modelcontextprotocol.spec.McpSchema.Resource
Returns the value of the uri record component.
uri() - Method in interface io.modelcontextprotocol.spec.McpSchema.ResourceContents
The URI of this resource.
uri() - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceReference
Returns the value of the uri record component.
uri() - Method in record class io.modelcontextprotocol.spec.McpSchema.Root
Returns the value of the uri record component.
uri() - Method in record class io.modelcontextprotocol.spec.McpSchema.SubscribeRequest
Returns the value of the uri record component.
uri() - Method in record class io.modelcontextprotocol.spec.McpSchema.TextResourceContents
Returns the value of the uri record component.
uri() - Method in record class io.modelcontextprotocol.spec.McpSchema.UnsubscribeRequest
Returns the value of the uri record component.
uriTemplate() - Method in record class io.modelcontextprotocol.spec.McpSchema.ResourceTemplate
Returns the value of the uriTemplate record component.
uriTemplateManagerFactory(McpUriTemplateManagerFactory) - Method in class io.modelcontextprotocol.server.McpServer.AsyncSpecification
Sets the URI template manager factory to use for creating URI templates.
uriTemplateManagerFactory(McpUriTemplateManagerFactory) - Method in class io.modelcontextprotocol.server.McpServer.SyncSpecification
Sets the URI template manager factory to use for creating URI templates.
USER - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.Role
 
UTF_8 - Static variable in class io.modelcontextprotocol.server.transport.HttpServletSseServerTransportProvider
 
Utils - Class in io.modelcontextprotocol.util
Miscellaneous utility methods.
Utils() - Constructor for class io.modelcontextprotocol.util.Utils
 

V

value() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteRequest.CompleteArgument
Returns the value of the value record component.
valueOf(String) - Static method in enum class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.ContextInclusionStrategy
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult.StopReason
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.modelcontextprotocol.spec.McpSchema.LoggingLevel
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.modelcontextprotocol.spec.McpSchema.Role
Returns the enum constant of this class with the specified name.
values() - Method in record class io.modelcontextprotocol.spec.McpSchema.CompleteResult.CompleteCompletion
Returns the value of the values record component.
values() - Static method in enum class io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest.ContextInclusionStrategy
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.modelcontextprotocol.spec.McpSchema.CreateMessageResult.StopReason
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.modelcontextprotocol.spec.McpSchema.LoggingLevel
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.modelcontextprotocol.spec.McpSchema.Role
Returns an array containing the constants of this enum class, in the order they are declared.
version() - Method in record class io.modelcontextprotocol.spec.McpSchema.Implementation
Returns the value of the version record component.

W

WARNING - Enum constant in enum class io.modelcontextprotocol.spec.McpSchema.LoggingLevel
 
A B C D E F G H I J L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form