McpSyncClient

java.lang.Object
- io.modelcontextprotocol.client.McpSyncClient

所有已实现的接口:

java.lang.AutoCloseable
```
public class McpSyncClient
extends java.lang.Object
implements java.lang.AutoCloseable
```
A synchronous client implementation for the Model Context Protocol (MCP) that wraps an McpAsyncClient to provide blocking operations.
This client implements the MCP specification by delegating to an asynchronous client and blocking on the results. Key features include:
- Synchronous, blocking API for simpler integration in non-reactive applications
- Tool discovery and invocation for server-provided functionality
- Resource access and management with URI-based addressing
- Prompt template handling for standardized AI interactions
- Real-time notifications for tools, resources, and prompts changes
- Structured logging with configurable severity levels
The client follows the same lifecycle as its async counterpart:
1. Initialization - Establishes connection and negotiates capabilities
2. Normal Operation - Handles requests and notifications
3. Graceful Shutdown - Ensures clean connection termination
This implementation implements AutoCloseable for resource cleanup and provides both immediate and graceful shutdown options. All operations block until completion or timeout, making it suitable for traditional synchronous programming models.
另请参阅:

McpClient, McpAsyncClient, McpSchema

构造器概要

构造器
构造器和说明

McpSyncClient(McpAsyncClient delegate)
已过时。
This method will be removed in 0.9.0. Use McpClient.sync(McpClientTransport) to obtain an instance.

构造器
构造器和说明
`McpSyncClient(McpAsyncClient delegate)` 已过时。 This method will be removed in 0.9.0. Use `McpClient.sync(McpClientTransport)` to obtain an instance.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addRoot(McpSchema.Root root)` Add a roots dynamically.
`McpSchema.CallToolResult`	`callTool(McpSchema.CallToolRequest callToolRequest)` Calls a tool provided by the server.
`void`	`close()`
`boolean`	`closeGracefully()`
`McpSchema.ClientCapabilities`	`getClientCapabilities()` Get the client capabilities that define the supported features and functionality.
`McpSchema.Implementation`	`getClientInfo()` Get the client implementation information.
`McpSchema.GetPromptResult`	`getPrompt(McpSchema.GetPromptRequest getPromptRequest)`
`McpSchema.ServerCapabilities`	`getServerCapabilities()` Get the server capabilities that define the supported features and functionality.
`McpSchema.Implementation`	`getServerInfo()` Get the server implementation information.
`McpSchema.InitializeResult`	`initialize()` The initialization phase MUST be the first interaction between client and server.
`boolean`	`isInitialized()` Check if the client-server connection is initialized.
`McpSchema.ListPromptsResult`	`listPrompts()`
`McpSchema.ListPromptsResult`	`listPrompts(java.lang.String cursor)`
`McpSchema.ListResourcesResult`	`listResources()` Send a resources/list request.
`McpSchema.ListResourcesResult`	`listResources(java.lang.String cursor)` Send a resources/list request.
`McpSchema.ListResourceTemplatesResult`	`listResourceTemplates()` Request a list of resource templates the server has.
`McpSchema.ListResourceTemplatesResult`	`listResourceTemplates(java.lang.String cursor)` Resource templates allow servers to expose parameterized resources using URI templates.
`McpSchema.ListToolsResult`	`listTools()` Retrieves the list of all tools provided by the server.
`McpSchema.ListToolsResult`	`listTools(java.lang.String cursor)` Retrieves a paginated list of tools provided by the server.
`java.lang.Object`	`ping()` Send a synchronous ping request.
`McpSchema.ReadResourceResult`	`readResource(McpSchema.ReadResourceRequest readResourceRequest)` Send a resources/read request.
`McpSchema.ReadResourceResult`	`readResource(McpSchema.Resource resource)` Send a resources/read request.
`void`	`removeRoot(java.lang.String rootUri)` Remove a root dynamically.
`void`	`rootsListChangedNotification()` Send a roots/list_changed notification.
`void`	`setLoggingLevel(McpSchema.LoggingLevel loggingLevel)` Client can set the minimum logging level it wants to receive from the server.
`void`	`subscribeResource(McpSchema.SubscribeRequest subscribeRequest)` Subscriptions.
`void`	`unsubscribeResource(McpSchema.UnsubscribeRequest unsubscribeRequest)` Send a resources/unsubscribe request.

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

- 构造器详细资料
  - McpSyncClient
```
@Deprecated
public McpSyncClient(McpAsyncClient delegate)
```
    已过时。 This method will be removed in 0.9.0. Use McpClient.sync(McpClientTransport) to obtain an instance.
    
    Create a new McpSyncClient with the given delegate.
    
    参数:
    
    delegate - the asynchronous kernel on top of which this synchronous client provides a blocking API.
- 方法详细资料
  - getServerCapabilities
```
public McpSchema.ServerCapabilities getServerCapabilities()
```
    Get the server capabilities that define the supported features and functionality.
    
    返回:
    
    The server capabilities
  - getServerInfo
```
public McpSchema.Implementation getServerInfo()
```
    Get the server implementation information.
    
    返回:
    
    The server implementation details
  - isInitialized
```
public boolean isInitialized()
```
    Check if the client-server connection is initialized.
    
    返回:
    
    true if the client-server connection is initialized
  - getClientCapabilities
```
public McpSchema.ClientCapabilities getClientCapabilities()
```
    Get the client capabilities that define the supported features and functionality.
    
    返回:
    
    The client capabilities
  - getClientInfo
```
public McpSchema.Implementation getClientInfo()
```
    Get the client implementation information.
    
    返回:
    
    The client implementation details
  - close
```
public void close()
```
    指定者:
    
    close 在接口中 java.lang.AutoCloseable
  - closeGracefully
```
public boolean closeGracefully()
```
  - initialize
```
public McpSchema.InitializeResult initialize()
```
    The initialization phase MUST be the first interaction between client and server. During this phase, the client and server:
    - Establish protocol version compatibility
    - Exchange and negotiate capabilities
    - Share implementation details
    The client MUST initiate this phase by sending an initialize request containing:
    - The protocol version the client supports
    - The client's capabilities
    - Client implementation information
    The server MUST respond with its own capabilities and information: McpSchema.ServerCapabilities.
    After successful initialization, the client MUST send an initialized notification to indicate it is ready to begin normal operations.
    Initialization Spec
    返回:
    
    the initialize result.
  - rootsListChangedNotification
```
public void rootsListChangedNotification()
```
    Send a roots/list_changed notification.
  - addRoot
```
public void addRoot(McpSchema.Root root)
```
    Add a roots dynamically.
  - removeRoot
```
public void removeRoot(java.lang.String rootUri)
```
    Remove a root dynamically.
  - ping
```
public java.lang.Object ping()
```
    Send a synchronous ping request.
    
    返回:
  - callTool
```
public McpSchema.CallToolResult callTool(McpSchema.CallToolRequest callToolRequest)
```
    Calls a tool provided by the server. Tools enable servers to expose executable functionality that can interact with external systems, perform computations, and take actions in the real world.
    
    参数:
    
    callToolRequest - The request containing: - name: The name of the tool to call (must match a tool name from tools/list) - arguments: Arguments that conform to the tool's input schema
    
    返回:
    
    The tool execution result containing: - content: List of content items (text, images, or embedded resources) representing the tool's output - isError: Boolean indicating if the execution failed (true) or succeeded (false/absent)
  - listTools
```
public McpSchema.ListToolsResult listTools()
```
    Retrieves the list of all tools provided by the server.
    
    返回:
    
    The list of tools result containing: - tools: List of available tools, each with a name, description, and input schema - nextCursor: Optional cursor for pagination if more tools are available
  - listTools
```
public McpSchema.ListToolsResult listTools(java.lang.String cursor)
```
    Retrieves a paginated list of tools provided by the server.
    
    参数:
    
    cursor - Optional pagination cursor from a previous list request
    
    返回:
    
    The list of tools result containing: - tools: List of available tools, each with a name, description, and input schema - nextCursor: Optional cursor for pagination if more tools are available
  - listResources
```
public McpSchema.ListResourcesResult listResources(java.lang.String cursor)
```
    Send a resources/list request.
    
    参数:
    
    cursor - the cursor
    
    返回:
    
    the list of resources result.
  - listResources
```
public McpSchema.ListResourcesResult listResources()
```
    Send a resources/list request.
    
    返回:
    
    the list of resources result.
  - readResource
```
public McpSchema.ReadResourceResult readResource(McpSchema.Resource resource)
```
    Send a resources/read request.
    
    参数:
    
    resource - the resource to read
    
    返回:
    
    the resource content.
  - readResource
```
public McpSchema.ReadResourceResult readResource(McpSchema.ReadResourceRequest readResourceRequest)
```
    Send a resources/read request.
    
    参数:
    
    readResourceRequest - the read resource request.
    
    返回:
    
    the resource content.
  - listResourceTemplates
```
public McpSchema.ListResourceTemplatesResult listResourceTemplates(java.lang.String cursor)
```
    Resource templates allow servers to expose parameterized resources using URI templates. Arguments may be auto-completed through the completion API. Request a list of resource templates the server has.
    
    参数:
    
    cursor - the cursor
    
    返回:
    
    the list of resource templates result.
  - listResourceTemplates
```
public McpSchema.ListResourceTemplatesResult listResourceTemplates()
```
    Request a list of resource templates the server has.
    
    返回:
    
    the list of resource templates result.
  - subscribeResource
```
public void subscribeResource(McpSchema.SubscribeRequest subscribeRequest)
```
    Subscriptions. The protocol supports optional subscriptions to resource changes. Clients can subscribe to specific resources and receive notifications when they change. Send a resources/subscribe request.
    
    参数:
    
    subscribeRequest - the subscribe request contains the uri of the resource to subscribe to.
  - unsubscribeResource
```
public void unsubscribeResource(McpSchema.UnsubscribeRequest unsubscribeRequest)
```
    Send a resources/unsubscribe request.
    
    参数:
    
    unsubscribeRequest - the unsubscribe request contains the uri of the resource to unsubscribe from.
  - listPrompts
```
public McpSchema.ListPromptsResult listPrompts(java.lang.String cursor)
```
  - listPrompts
```
public McpSchema.ListPromptsResult listPrompts()
```
  - getPrompt
```
public McpSchema.GetPromptResult getPrompt(McpSchema.GetPromptRequest getPromptRequest)
```
  - setLoggingLevel
```
public void setLoggingLevel(McpSchema.LoggingLevel loggingLevel)
```
    Client can set the minimum logging level it wants to receive from the server.
    
    参数:
    
    loggingLevel - the min logging level

类 McpSyncClient

构造器概要

方法概要

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

构造器详细资料

McpSyncClient

方法详细资料

getServerCapabilities

getServerInfo

isInitialized

getClientCapabilities

getClientInfo

close

closeGracefully

initialize

rootsListChangedNotification

addRoot

removeRoot

ping

callTool

listTools

listTools

listResources

listResources

readResource

readResource

listResourceTemplates

listResourceTemplates

subscribeResource

unsubscribeResource

listPrompts

listPrompts

getPrompt

setLoggingLevel