Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.server

Class McpServer.StatelessSyncSpecification

java.lang.Object

io.modelcontextprotocol.server.McpServer.StatelessSyncSpecification

Enclosing interface:

McpServer

public static class McpServer.StatelessSyncSpecification
extends Object

Constructor Summary

Constructors

Constructor	Description
StatelessSyncSpecification(McpStatelessServerTransport transport)

Method Summary

Modifier and Type	Method	Description
McpStatelessSyncServer	build()
McpServer.StatelessSyncSpecification	capabilities(McpSchema.ServerCapabilities serverCapabilities)	Sets the server capabilities that will be advertised to clients during connection initialization.
McpServer.StatelessSyncSpecification	completions(McpStatelessServerFeatures.SyncCompletionSpecification... completions)	Registers multiple completions with their handlers using varargs.
McpServer.StatelessSyncSpecification	completions(List<McpStatelessServerFeatures.SyncCompletionSpecification> completions)	Registers multiple completions with their handlers using a List.
McpServer.StatelessSyncSpecification	immediateExecution(boolean immediateExecution)	Enable on "immediate execution" of the operations on the underlying McpStatelessAsyncServer.
McpServer.StatelessSyncSpecification	instructions(String instructions)	Sets the server instructions that will be shared with clients during connection initialization.
McpServer.StatelessSyncSpecification	jsonSchemaValidator(JsonSchemaValidator jsonSchemaValidator)	Sets the JSON schema validator to use for validating tool and resource schemas.
McpServer.StatelessSyncSpecification	objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Sets the object mapper to use for serializing and deserializing JSON messages.
McpServer.StatelessSyncSpecification	prompts(McpStatelessServerFeatures.SyncPromptSpecification... prompts)	Registers multiple prompts with their handlers using varargs.
McpServer.StatelessSyncSpecification	prompts(List<McpStatelessServerFeatures.SyncPromptSpecification> prompts)	Registers multiple prompts with their handlers using a List.
McpServer.StatelessSyncSpecification	prompts(Map<String,McpStatelessServerFeatures.SyncPromptSpecification> prompts)	Registers multiple prompts with their handlers using a Map.
McpServer.StatelessSyncSpecification	requestTimeout(Duration requestTimeout)	Sets the duration to wait for server responses before timing out requests.
McpServer.StatelessSyncSpecification	resources(McpStatelessServerFeatures.SyncResourceSpecification... resourceSpecifications)	Registers multiple resources with their handlers using varargs.
McpServer.StatelessSyncSpecification	resources(List<McpStatelessServerFeatures.SyncResourceSpecification> resourceSpecifications)	Registers multiple resources with their handlers using a List.
McpServer.StatelessSyncSpecification	resources(Map<String,McpStatelessServerFeatures.SyncResourceSpecification> resourceSpecifications)	Registers multiple resources with their handlers using a Map.
McpServer.StatelessSyncSpecification	resourceTemplates(McpSchema.ResourceTemplate... resourceTemplates)	Sets the resource templates using varargs for convenience.
McpServer.StatelessSyncSpecification	resourceTemplates(List<McpSchema.ResourceTemplate> resourceTemplates)	Sets the resource templates that define patterns for dynamic resource access.
McpServer.StatelessSyncSpecification	serverInfo(McpSchema.Implementation serverInfo)	Sets the server implementation information that will be shared with clients during connection initialization.
McpServer.StatelessSyncSpecification	serverInfo(String name, String version)	Sets the server implementation information using name and version strings.
McpServer.StatelessSyncSpecification	toolCall(McpSchema.Tool tool, BiFunction<McpTransportContext,McpSchema.CallToolRequest,McpSchema.CallToolResult> callHandler)	Adds a single tool with its implementation handler to the server.
McpServer.StatelessSyncSpecification	tools(McpStatelessServerFeatures.SyncToolSpecification... toolSpecifications)	Adds multiple tools with their handlers to the server using varargs.
McpServer.StatelessSyncSpecification	tools(List<McpStatelessServerFeatures.SyncToolSpecification> toolSpecifications)	Adds multiple tools with their handlers to the server using a List.
McpServer.StatelessSyncSpecification	uriTemplateManagerFactory(McpUriTemplateManagerFactory uriTemplateManagerFactory)	Sets the URI template manager factory to use for creating URI templates.

Methods inherited from class java.lang.Object

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

Constructor Details

StatelessSyncSpecification

public StatelessSyncSpecification(McpStatelessServerTransport transport)

Method Details

uriTemplateManagerFactory

public McpServer.StatelessSyncSpecification uriTemplateManagerFactory(McpUriTemplateManagerFactory uriTemplateManagerFactory)

Sets the URI template manager factory to use for creating URI templates. This allows for custom URI template parsing and variable extraction.

Parameters:

uriTemplateManagerFactory - The factory to use. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if uriTemplateManagerFactory is null

requestTimeout

public McpServer.StatelessSyncSpecification requestTimeout(Duration requestTimeout)

Sets the duration to wait for server responses before timing out requests. This timeout applies to all requests made through the client, including tool calls, resource access, and prompt operations.

Parameters:

requestTimeout - The duration to wait before timing out requests. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if requestTimeout is null

serverInfo

public McpServer.StatelessSyncSpecification serverInfo(McpSchema.Implementation serverInfo)

Sets the server implementation information that will be shared with clients during connection initialization. This helps with version compatibility, debugging, and server identification.

Parameters:

serverInfo - The server implementation details including name and version. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if serverInfo is null

serverInfo

public McpServer.StatelessSyncSpecification serverInfo(String name,
 String version)

Sets the server implementation information using name and version strings. This is a convenience method alternative to serverInfo(McpSchema.Implementation).

Parameters:

name - The server name. Must not be null or empty.

version - The server version. Must not be null or empty.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if name or version is null or empty

See Also:

• serverInfo(McpSchema.Implementation)

instructions

public McpServer.StatelessSyncSpecification instructions(String instructions)

Sets the server instructions that will be shared with clients during connection initialization. These instructions provide guidance to the client on how to interact with this server.

Parameters:

instructions - The instructions text. Can be null or empty.

Returns:

This builder instance for method chaining

capabilities

public McpServer.StatelessSyncSpecification capabilities(McpSchema.ServerCapabilities serverCapabilities)

Sets the server capabilities that will be advertised to clients during connection initialization. Capabilities define what features the server supports, such as:

• Tool execution
• Resource access
• Prompt handling

Parameters:

serverCapabilities - The server capabilities configuration. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if serverCapabilities is null

toolCall

public McpServer.StatelessSyncSpecification toolCall(McpSchema.Tool tool,
 BiFunction<McpTransportContext,McpSchema.CallToolRequest,McpSchema.CallToolResult> callHandler)

Adds a single tool with its implementation handler to the server. This is a convenience method for registering individual tools without creating a McpServerFeatures.SyncToolSpecification explicitly.

Parameters:

tool - The tool definition including name, description, and schema. Must not be null.

callHandler - The function that implements the tool's logic. Must not be null. The function's first argument is an McpSyncServerExchange upon which the server can interact with the connected client. The second argument is the McpSchema.CallToolRequest object containing the tool call

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if tool or handler is null

tools

public McpServer.StatelessSyncSpecification tools(List<McpStatelessServerFeatures.SyncToolSpecification> toolSpecifications)

Adds multiple tools with their handlers to the server using a List. This method is useful when tools are dynamically generated or loaded from a configuration source.

Parameters:

toolSpecifications - The list of tool specifications to add. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if toolSpecifications is null

See Also:

• tools(McpStatelessServerFeatures.SyncToolSpecification...)

tools

public McpServer.StatelessSyncSpecification tools(McpStatelessServerFeatures.SyncToolSpecification... toolSpecifications)

Adds multiple tools with their handlers to the server using varargs. This method provides a convenient way to register multiple tools inline.

Example usage:

 .tools(
     McpServerFeatures.SyncToolSpecification.builder().tool(calculatorTool).callTool(calculatorHandler).build(),
     McpServerFeatures.SyncToolSpecification.builder().tool(weatherTool).callTool(weatherHandler).build(),
     McpServerFeatures.SyncToolSpecification.builder().tool(fileManagerTool).callTool(fileManagerHandler).build()
 )
 

Parameters:

toolSpecifications - The tool specifications to add. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if toolSpecifications is null

resources

public McpServer.StatelessSyncSpecification resources(Map<String,McpStatelessServerFeatures.SyncResourceSpecification> resourceSpecifications)

Registers multiple resources with their handlers using a Map. This method is useful when resources are dynamically generated or loaded from a configuration source.

Parameters:

resourceSpecifications - Map of resource name to specification. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if resourceSpecifications is null

See Also:

• resources(McpStatelessServerFeatures.SyncResourceSpecification...)

resources

public McpServer.StatelessSyncSpecification resources(List<McpStatelessServerFeatures.SyncResourceSpecification> resourceSpecifications)

Registers multiple resources with their handlers using a List. This method is useful when resources need to be added in bulk from a collection.

Parameters:

resourceSpecifications - List of resource specifications. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if resourceSpecifications is null

See Also:

• resources(McpStatelessServerFeatures.SyncResourceSpecification...)

resources

public McpServer.StatelessSyncSpecification resources(McpStatelessServerFeatures.SyncResourceSpecification... resourceSpecifications)

Registers multiple resources with their handlers using varargs. This method provides a convenient way to register multiple resources inline.

Example usage:

 .resources(
     new McpServerFeatures.SyncResourceSpecification(fileResource, fileHandler),
     new McpServerFeatures.SyncResourceSpecification(dbResource, dbHandler),
     new McpServerFeatures.SyncResourceSpecification(apiResource, apiHandler)
 )
 

Parameters:

resourceSpecifications - The resource specifications to add. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if resourceSpecifications is null

resourceTemplates

public McpServer.StatelessSyncSpecification resourceTemplates(List<McpSchema.ResourceTemplate> resourceTemplates)

Sets the resource templates that define patterns for dynamic resource access. Templates use URI patterns with placeholders that can be filled at runtime.

Example usage:

 .resourceTemplates(
     new ResourceTemplate("file://{path}", "Access files by path"),
     new ResourceTemplate("db://{table}/{id}", "Access database records")
 )
 

Parameters:

resourceTemplates - List of resource templates. If null, clears existing templates.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if resourceTemplates is null.

See Also:

• resourceTemplates(ResourceTemplate...)

resourceTemplates

public McpServer.StatelessSyncSpecification resourceTemplates(McpSchema.ResourceTemplate... resourceTemplates)

Sets the resource templates using varargs for convenience. This is an alternative to resourceTemplates(List).

Parameters:

resourceTemplates - The resource templates to set.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if resourceTemplates is null.

See Also:

• resourceTemplates(List)

prompts

public McpServer.StatelessSyncSpecification prompts(Map<String,McpStatelessServerFeatures.SyncPromptSpecification> prompts)

Registers multiple prompts with their handlers using a Map. This method is useful when prompts are dynamically generated or loaded from a configuration source.

Example usage:

 .prompts(Map.of("analysis", new McpServerFeatures.SyncPromptSpecification(
     new Prompt("analysis", "Code analysis template"),
     request -> Mono.fromSupplier(() -> generateAnalysisPrompt(request))
         .map(GetPromptResult::new)
 )));
 

Parameters:

prompts - Map of prompt name to specification. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if prompts is null

prompts

public McpServer.StatelessSyncSpecification prompts(List<McpStatelessServerFeatures.SyncPromptSpecification> prompts)

Registers multiple prompts with their handlers using a List. This method is useful when prompts need to be added in bulk from a collection.

Parameters:

prompts - List of prompt specifications. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if prompts is null

See Also:

• prompts(McpStatelessServerFeatures.SyncPromptSpecification...)

prompts

public McpServer.StatelessSyncSpecification prompts(McpStatelessServerFeatures.SyncPromptSpecification... prompts)

Registers multiple prompts with their handlers using varargs. This method provides a convenient way to register multiple prompts inline.

Example usage:

 .prompts(
     new McpServerFeatures.SyncPromptSpecification(analysisPrompt, analysisHandler),
     new McpServerFeatures.SyncPromptSpecification(summaryPrompt, summaryHandler),
     new McpServerFeatures.SyncPromptSpecification(reviewPrompt, reviewHandler)
 )
 

Parameters:

prompts - The prompt specifications to add. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if prompts is null

completions

public McpServer.StatelessSyncSpecification completions(List<McpStatelessServerFeatures.SyncCompletionSpecification> completions)

Registers multiple completions with their handlers using a List. This method is useful when completions need to be added in bulk from a collection.

Parameters:

completions - List of completion specifications. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if completions is null

completions

public McpServer.StatelessSyncSpecification completions(McpStatelessServerFeatures.SyncCompletionSpecification... completions)

Registers multiple completions with their handlers using varargs. This method is useful when completions are defined inline and added directly.

Parameters:

completions - Array of completion specifications. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if completions is null

objectMapper

public McpServer.StatelessSyncSpecification objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Sets the object mapper to use for serializing and deserializing JSON messages.

Parameters:

objectMapper - the instance to use. Must not be null.

Returns:

This builder instance for method chaining.

Throws:

IllegalArgumentException - if objectMapper is null

jsonSchemaValidator

public McpServer.StatelessSyncSpecification jsonSchemaValidator(JsonSchemaValidator jsonSchemaValidator)

Sets the JSON schema validator to use for validating tool and resource schemas. This ensures that the server's tools and resources conform to the expected schema definitions.

Parameters:

jsonSchemaValidator - The validator to use. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if jsonSchemaValidator is null

immediateExecution

public McpServer.StatelessSyncSpecification immediateExecution(boolean immediateExecution)

Enable on "immediate execution" of the operations on the underlying McpStatelessAsyncServer. Defaults to false, which does blocking code offloading to prevent accidental blocking of the non-blocking transport.

Do NOT set to true if the underlying transport is a non-blocking implementation.

Parameters:

immediateExecution - When true, do not offload work asynchronously.

Returns:

This builder instance for method chaining.

build

public McpStatelessSyncServer build()