McpClient.SyncSpec

java.lang.Object
- io.modelcontextprotocol.client.McpClient.SyncSpec

封闭接口:

McpClient
```
public static class McpClient.SyncSpec
extends java.lang.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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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`	`elicitation(java.util.function.Function<McpSchema.ElicitRequest,McpSchema.ElicitResult> elicitationHandler)` Sets a custom elicitation handler for processing elicitation message requests.
`McpClient.SyncSpec`	`enableCallToolSchemaCaching(boolean enableCallToolSchemaCaching)` Enables automatic schema caching during callTool operations.
`McpClient.SyncSpec`	`initializationTimeout(java.time.Duration initializationTimeout)`
`McpClient.SyncSpec`	`jsonSchemaValidator(JsonSchemaValidator jsonSchemaValidator)` Add a `JsonSchemaValidator` to validate the JSON structure of the structured output.
`McpClient.SyncSpec`	`loggingConsumer(java.util.function.Consumer<McpSchema.LoggingMessageNotification> loggingConsumer)` Adds a consumer to be notified when logging messages are received from the server.
`McpClient.SyncSpec`	`loggingConsumers(java.util.List<java.util.function.Consumer<McpSchema.LoggingMessageNotification>> loggingConsumers)` Adds multiple consumers to be notified when logging messages are received from the server.
`McpClient.SyncSpec`	`progressConsumer(java.util.function.Consumer<McpSchema.ProgressNotification> progressConsumer)` Adds a consumer to be notified of progress notifications from the server.
`McpClient.SyncSpec`	`progressConsumers(java.util.List<java.util.function.Consumer<McpSchema.ProgressNotification>> progressConsumers)` Adds a multiple consumers to be notified of progress notifications from the server.
`McpClient.SyncSpec`	`promptsChangeConsumer(java.util.function.Consumer<java.util.List<McpSchema.Prompt>> promptsChangeConsumer)` Adds a consumer to be notified when the available prompts change.
`McpClient.SyncSpec`	`requestTimeout(java.time.Duration requestTimeout)` Sets the duration to wait for server responses before timing out requests.
`McpClient.SyncSpec`	`resourcesChangeConsumer(java.util.function.Consumer<java.util.List<McpSchema.Resource>> resourcesChangeConsumer)` Adds a consumer to be notified when the available resources change.
`McpClient.SyncSpec`	`resourcesUpdateConsumer(java.util.function.Consumer<java.util.List<McpSchema.ResourceContents>> resourcesUpdateConsumer)` Adds a consumer to be notified when a specific resource is updated.
`McpClient.SyncSpec`	`roots(java.util.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(java.util.function.Function<McpSchema.CreateMessageRequest,McpSchema.CreateMessageResult> samplingHandler)` Sets a custom sampling handler for processing message creation requests.
`McpClient.SyncSpec`	`toolsChangeConsumer(java.util.function.Consumer<java.util.List<McpSchema.Tool>> toolsChangeConsumer)` Adds a consumer to be notified when the available tools change.
`McpClient.SyncSpec`	`transportContextProvider(java.util.function.Supplier<McpTransportContext> contextProvider)` Add a provider of `McpTransportContext`, providing a context before calling any client operation.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - requestTimeout
```
public McpClient.SyncSpec requestTimeout(java.time.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.
    
    参数:
    
    requestTimeout - The duration to wait before timing out requests. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if requestTimeout is null
  - initializationTimeout
```
public McpClient.SyncSpec initializationTimeout(java.time.Duration initializationTimeout)
```
    参数:
    
    initializationTimeout - The duration to wait for the initialization lifecycle step to complete.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.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.
    
    参数:
    
    capabilities - The client capabilities configuration. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.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.
    
    参数:
    
    clientInfo - The client implementation details including name and version. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if clientInfo is null
  - roots
```
public McpClient.SyncSpec roots(java.util.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.
    
    参数:
    
    roots - A list of root definitions. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.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).
    
    参数:
    
    roots - An array of root definitions. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if roots is null
    
    另请参阅:
    
    roots(List)
  - sampling
```
public McpClient.SyncSpec sampling(java.util.function.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.
    
    参数:
    
    samplingHandler - A function that processes message requests and returns results. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if samplingHandler is null
  - elicitation
```
public McpClient.SyncSpec elicitation(java.util.function.Function<McpSchema.ElicitRequest,McpSchema.ElicitResult> elicitationHandler)
```
    Sets a custom elicitation handler for processing elicitation message requests. The elicitation handler can modify or validate messages before they are sent to the server, enabling custom processing logic.
    
    参数:
    
    elicitationHandler - A function that processes elicitation requests and returns results. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if elicitationHandler is null
  - toolsChangeConsumer
```
public McpClient.SyncSpec toolsChangeConsumer(java.util.function.Consumer<java.util.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.
    
    参数:
    
    toolsChangeConsumer - A consumer that receives the updated list of available tools. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if toolsChangeConsumer is null
  - resourcesChangeConsumer
```
public McpClient.SyncSpec resourcesChangeConsumer(java.util.function.Consumer<java.util.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.
    
    参数:
    
    resourcesChangeConsumer - A consumer that receives the updated list of available resources. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if resourcesChangeConsumer is null
  - resourcesUpdateConsumer
```
public McpClient.SyncSpec resourcesUpdateConsumer(java.util.function.Consumer<java.util.List<McpSchema.ResourceContents>> resourcesUpdateConsumer)
```
    Adds a consumer to be notified when a specific resource is updated. This allows the client to react to changes in individual resources, such as updates to their content or metadata.
    
    参数:
    
    resourcesUpdateConsumer - A consumer function that processes the updated resource and returns a Mono indicating the completion of the processing. Must not be null.
    
    返回:
    
    This builder instance for method chaining.
    
    抛出:
    
    java.lang.IllegalArgumentException - If the resourcesUpdateConsumer is null.
  - promptsChangeConsumer
```
public McpClient.SyncSpec promptsChangeConsumer(java.util.function.Consumer<java.util.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.
    
    参数:
    
    promptsChangeConsumer - A consumer that receives the updated list of available prompts. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if promptsChangeConsumer is null
  - loggingConsumer
```
public McpClient.SyncSpec loggingConsumer(java.util.function.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.
    
    参数:
    
    loggingConsumer - A consumer that receives logging messages. Must not be null.
    
    返回:
    
    This builder instance for method chaining
  - loggingConsumers
```
public McpClient.SyncSpec loggingConsumers(java.util.List<java.util.function.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.
    
    参数:
    
    loggingConsumers - A list of consumers that receive logging messages. Must not be null.
    
    返回:
    
    This builder instance for method chaining
  - progressConsumer
```
public McpClient.SyncSpec progressConsumer(java.util.function.Consumer<McpSchema.ProgressNotification> progressConsumer)
```
    Adds a consumer to be notified of progress notifications from the server. This allows the client to track long-running operations and provide feedback to users.
    
    参数:
    
    progressConsumer - A consumer that receives progress notifications. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if progressConsumer is null
  - progressConsumers
```
public McpClient.SyncSpec progressConsumers(java.util.List<java.util.function.Consumer<McpSchema.ProgressNotification>> progressConsumers)
```
    Adds a multiple consumers to be notified of progress notifications from the server. This allows the client to track long-running operations and provide feedback to users.
    
    参数:
    
    progressConsumers - A list of consumers that receives progress notifications. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if progressConsumer is null
  - transportContextProvider
```
public McpClient.SyncSpec transportContextProvider(java.util.function.Supplier<McpTransportContext> contextProvider)
```
    Add a provider of McpTransportContext, providing a context before calling any client operation. This allows to extract thread-locals and hand them over to the underlying transport.
    There is no direct equivalent in McpClient.AsyncSpec. To achieve the same result, append contextWrite(McpTransportContext.KEY, context) to any McpAsyncClient call.
    
    参数:
    
    contextProvider - A supplier to create a context
    
    返回:
    
    This builder for method chaining
  - jsonSchemaValidator
```
public McpClient.SyncSpec jsonSchemaValidator(JsonSchemaValidator jsonSchemaValidator)
```
    Add a JsonSchemaValidator to validate the JSON structure of the structured output.
    
    参数:
    
    jsonSchemaValidator - A validator to validate the JSON structure of the structured output. Must not be null.
    
    返回:
    
    This builder for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if jsonSchemaValidator is null
  - enableCallToolSchemaCaching
```
public McpClient.SyncSpec enableCallToolSchemaCaching(boolean enableCallToolSchemaCaching)
```
    Enables automatic schema caching during callTool operations. When a tool's output schema is not found in the cache, callTool will automatically fetch and cache all tool schemas via listTools.
    
    参数:
    
    enableCallToolSchemaCaching - true to enable, false to disable
    
    返回:
    
    This builder instance for method chaining
  - build
```
public McpSyncClient build()
```
    Create an instance of McpSyncClient with the provided configurations or sensible defaults.
    
    返回:
    
    a new instance of McpSyncClient.

类 McpClient.SyncSpec

方法概要

从类继承的方法 java.lang.Object

方法详细资料

requestTimeout

initializationTimeout

capabilities

clientInfo

roots

roots

sampling

elicitation

toolsChangeConsumer

resourcesChangeConsumer

resourcesUpdateConsumer

promptsChangeConsumer

loggingConsumer

loggingConsumers

progressConsumer

progressConsumers

transportContextProvider

jsonSchemaValidator

enableCallToolSchemaCaching

build