io.modelcontextprotocol.client

Class McpClient.SyncSpec

java.lang.Object

io.modelcontextprotocol.client.McpClient.SyncSpec

Enclosing interface:

McpClient

public static class McpClient.SyncSpec
extends Object

Synchronous client specification. This class follows the builder pattern to provide a fluent API for setting up clients with custom configurations.

The builder supports configuration of:

• Transport layer for client-server communication
• Request timeouts for operation boundaries
• Client capabilities for feature negotiation
• Client implementation details for version tracking
• Root URIs for resource access
• Change notification handlers for tools, resources, and prompts
• Custom message sampling logic

Method Summary

Modifier and Type	Method and Description
McpSyncClient	build() Create an instance of McpSyncClient with the provided configurations or sensible defaults.
McpClient.SyncSpec	capabilities(McpSchema.ClientCapabilities capabilities) Sets the client capabilities that will be advertised to the server during connection initialization.
McpClient.SyncSpec	clientInfo(McpSchema.Implementation clientInfo) Sets the client implementation information that will be shared with the server during connection initialization.
McpClient.SyncSpec	initializationTimeout(Duration initializationTimeout)
McpClient.SyncSpec	loggingConsumer(Consumer<McpSchema.LoggingMessageNotification> loggingConsumer) Adds a consumer to be notified when logging messages are received from the server.
McpClient.SyncSpec	loggingConsumers(List<Consumer<McpSchema.LoggingMessageNotification>> loggingConsumers) Adds multiple consumers to be notified when logging messages are received from the server.
McpClient.SyncSpec	promptsChangeConsumer(Consumer<List<McpSchema.Prompt>> promptsChangeConsumer) Adds a consumer to be notified when the available prompts change.
McpClient.SyncSpec	requestTimeout(Duration requestTimeout) Sets the duration to wait for server responses before timing out requests.
McpClient.SyncSpec	resourcesChangeConsumer(Consumer<List<McpSchema.Resource>> resourcesChangeConsumer) Adds a consumer to be notified when the available resources change.
McpClient.SyncSpec	roots(List<McpSchema.Root> roots) Sets the root URIs that this client can access.
McpClient.SyncSpec	roots(McpSchema.Root... roots) Sets the root URIs that this client can access, using a varargs parameter for convenience.
McpClient.SyncSpec	sampling(Function<McpSchema.CreateMessageRequest,McpSchema.CreateMessageResult> samplingHandler) Sets a custom sampling handler for processing message creation requests.
McpClient.SyncSpec	toolsChangeConsumer(Consumer<List<McpSchema.Tool>> toolsChangeConsumer) Adds a consumer to be notified when the available tools change.
McpClient.SyncSpec	withConnectOnInit(boolean connectOnInit) Sets whether to connect to the server during the initialization phase (open an SSE stream).

Methods inherited from class java.lang.Object

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

Method Detail

requestTimeout

public McpClient.SyncSpec 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

withConnectOnInit

public McpClient.SyncSpec withConnectOnInit(boolean connectOnInit)

Sets whether to connect to the server during the initialization phase (open an SSE stream).

Parameters:

connectOnInit - true to open an SSE stream during the initialization

Returns:

This builder instance for method chaining

initializationTimeout

public McpClient.SyncSpec initializationTimeout(Duration initializationTimeout)

Parameters:

initializationTimeout - The duration to wait for the initializaiton lifecycle step to complete.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if initializationTimeout is null

capabilities

public McpClient.SyncSpec capabilities(McpSchema.ClientCapabilities capabilities)

Sets the client capabilities that will be advertised to the server during connection initialization. Capabilities define what features the client supports, such as tool execution, resource access, and prompt handling.

Parameters:

capabilities - The client capabilities configuration. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if capabilities is null

clientInfo

public McpClient.SyncSpec clientInfo(McpSchema.Implementation clientInfo)

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

Parameters:

clientInfo - The client implementation details including name and version. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if clientInfo is null

roots

public McpClient.SyncSpec roots(List<McpSchema.Root> roots)

Sets the root URIs that this client can access. Roots define the base URIs for resources that the client can request from the server. For example, a root might be "file://workspace" for accessing workspace files.

Parameters:

roots - A list of root definitions. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if roots is null

roots

public McpClient.SyncSpec roots(McpSchema.Root... roots)

Sets the root URIs that this client can access, using a varargs parameter for convenience. This is an alternative to roots(List).

Parameters:

roots - An array of root definitions. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if roots is null

See Also:

roots(List)

sampling

public McpClient.SyncSpec sampling(Function<McpSchema.CreateMessageRequest,McpSchema.CreateMessageResult> samplingHandler)

Sets a custom sampling handler for processing message creation requests. The sampling handler can modify or validate messages before they are sent to the server, enabling custom processing logic.

Parameters:

samplingHandler - A function that processes message requests and returns results. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if samplingHandler is null

toolsChangeConsumer

public McpClient.SyncSpec toolsChangeConsumer(Consumer<List<McpSchema.Tool>> toolsChangeConsumer)

Adds a consumer to be notified when the available tools change. This allows the client to react to changes in the server's tool capabilities, such as tools being added or removed.

Parameters:

toolsChangeConsumer - A consumer that receives the updated list of available tools. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if toolsChangeConsumer is null

resourcesChangeConsumer

public McpClient.SyncSpec resourcesChangeConsumer(Consumer<List<McpSchema.Resource>> resourcesChangeConsumer)

Adds a consumer to be notified when the available resources change. This allows the client to react to changes in the server's resource availability, such as files being added or removed.

Parameters:

resourcesChangeConsumer - A consumer that receives the updated list of available resources. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if resourcesChangeConsumer is null

promptsChangeConsumer

public McpClient.SyncSpec promptsChangeConsumer(Consumer<List<McpSchema.Prompt>> promptsChangeConsumer)

Adds a consumer to be notified when the available prompts change. This allows the client to react to changes in the server's prompt templates, such as new templates being added or existing ones being modified.

Parameters:

promptsChangeConsumer - A consumer that receives the updated list of available prompts. Must not be null.

Returns:

This builder instance for method chaining

Throws:

IllegalArgumentException - if promptsChangeConsumer is null

loggingConsumer

public McpClient.SyncSpec loggingConsumer(Consumer<McpSchema.LoggingMessageNotification> loggingConsumer)

Adds a consumer to be notified when logging messages are received from the server. This allows the client to react to log messages, such as warnings or errors, that are sent by the server.

Parameters:

loggingConsumer - A consumer that receives logging messages. Must not be null.

Returns:

This builder instance for method chaining

loggingConsumers

public McpClient.SyncSpec loggingConsumers(List<Consumer<McpSchema.LoggingMessageNotification>> loggingConsumers)

Adds multiple consumers to be notified when logging messages are received from the server. This allows the client to react to log messages, such as warnings or errors, that are sent by the server.

Parameters:

loggingConsumers - A list of consumers that receive logging messages. Must not be null.

Returns:

This builder instance for method chaining

build

public McpSyncClient build()

Create an instance of McpSyncClient with the provided configurations or sensible defaults.

Returns:

a new instance of McpSyncClient.