McpSyncServer

java.lang.Object
- io.modelcontextprotocol.server.McpSyncServer

```
public class McpSyncServer
extends java.lang.Object
```
A synchronous implementation of the Model Context Protocol (MCP) server that wraps McpAsyncServer to provide blocking operations. This class delegates all operations to an underlying async server instance while providing a simpler, synchronous API for scenarios where reactive programming is not required.
The MCP server enables AI models to expose tools, resources, and prompts through a standardized interface. Key features available through this synchronous API include:
- Tool registration and management for extending AI model capabilities
- Resource handling with URI-based addressing for providing context
- Prompt template management for standardized interactions
- Real-time client notifications for state changes
- Structured logging with configurable severity levels
- Support for client-side AI model sampling
While McpAsyncServer uses Project Reactor's Mono and Flux types for non-blocking operations, this class converts those into blocking calls, making it more suitable for:
- Traditional synchronous applications
- Simple scripting scenarios
- Testing and debugging
- Cases where reactive programming adds unnecessary complexity
The server supports runtime modification of its capabilities through methods like addTool(io.modelcontextprotocol.server.McpServerFeatures.SyncToolSpecification), addResource(io.modelcontextprotocol.server.McpServerFeatures.SyncResourceSpecification), and addPrompt(io.modelcontextprotocol.server.McpServerFeatures.SyncPromptSpecification), automatically notifying connected clients of changes when configured to do so.
另请参阅:

McpAsyncServer, McpSchema

构造器概要

构造器
构造器和说明

McpSyncServer(McpAsyncServer asyncServer)
Creates a new synchronous server that wraps the provided async server.

构造器
构造器和说明
`McpSyncServer(McpAsyncServer asyncServer)` Creates a new synchronous server that wraps the provided async server.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addPrompt(McpServerFeatures.SyncPromptSpecification promptSpecification)` Add a new prompt handler.
`void`	`addResource(McpServerFeatures.SyncResourceSpecification resourceHandler)` Add a new resource handler.
`void`	`addResourceTemplate(McpServerFeatures.SyncResourceTemplateSpecification resourceHandler)` Add a new resource template handler.
`void`	`addTool(McpServerFeatures.SyncToolSpecification toolHandler)` Add a new tool handler.
`void`	`close()` Close the server immediately.
`void`	`closeGracefully()` Close the server gracefully.
`McpAsyncServer`	`getAsyncServer()` Get the underlying async server instance.
`McpSchema.ServerCapabilities`	`getServerCapabilities()` Get the server capabilities that define the supported features and functionality.
`McpSchema.Implementation`	`getServerInfo()` Get the server implementation information.
`void`	`loggingNotification(McpSchema.LoggingMessageNotification loggingMessageNotification)` Send a logging message notification to all clients.
`void`	`notifyPromptsListChanged()` Notify clients that the list of available prompts has changed.
`void`	`notifyResourcesListChanged()` Notify clients that the list of available resources has changed.
`void`	`notifyToolsListChanged()` Notify clients that the list of available tools has changed.
`void`	`removePrompt(java.lang.String promptName)` Remove a prompt handler.
`void`	`removeResource(java.lang.String resourceUri)` Remove a resource handler.
`void`	`removeResourceTemplate(java.lang.String resourceUri)` Remove a resource template handler.
`void`	`removeTool(java.lang.String toolName)` Remove a tool handler.

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

- 构造器详细资料
  - McpSyncServer
```
public McpSyncServer(McpAsyncServer asyncServer)
```
    Creates a new synchronous server that wraps the provided async server.
    
    参数:
    
    asyncServer - The async server to wrap
- 方法详细资料
  - addTool
```
public void addTool(McpServerFeatures.SyncToolSpecification toolHandler)
```
    Add a new tool handler.
    
    参数:
    
    toolHandler - The tool handler to add
  - removeTool
```
public void removeTool(java.lang.String toolName)
```
    Remove a tool handler.
    
    参数:
    
    toolName - The name of the tool handler to remove
  - addResource
```
public void addResource(McpServerFeatures.SyncResourceSpecification resourceHandler)
```
    Add a new resource handler.
    
    参数:
    
    resourceHandler - The resource handler to add
  - removeResource
```
public void removeResource(java.lang.String resourceUri)
```
    Remove a resource handler.
    
    参数:
    
    resourceUri - The URI of the resource handler to remove
  - addResourceTemplate
```
public void addResourceTemplate(McpServerFeatures.SyncResourceTemplateSpecification resourceHandler)
```
    Add a new resource template handler.
    
    参数:
    
    resourceHandler - The resource handler to add
  - removeResourceTemplate
```
public void removeResourceTemplate(java.lang.String resourceUri)
```
    Remove a resource template handler.
    
    参数:
    
    resourceUri - The URI of the resource template handler to remove
  - addPrompt
```
public void addPrompt(McpServerFeatures.SyncPromptSpecification promptSpecification)
```
    Add a new prompt handler.
    
    参数:
    
    promptSpecification - The prompt specification to add
  - removePrompt
```
public void removePrompt(java.lang.String promptName)
```
    Remove a prompt handler.
    
    参数:
    
    promptName - The name of the prompt handler to remove
  - notifyToolsListChanged
```
public void notifyToolsListChanged()
```
    Notify clients that the list of available tools has changed.
  - 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
  - notifyResourcesListChanged
```
public void notifyResourcesListChanged()
```
    Notify clients that the list of available resources has changed.
  - notifyPromptsListChanged
```
public void notifyPromptsListChanged()
```
    Notify clients that the list of available prompts has changed.
  - loggingNotification
```
public void loggingNotification(McpSchema.LoggingMessageNotification loggingMessageNotification)
```
    Send a logging message notification to all clients.
    
    参数:
    
    loggingMessageNotification - The logging message notification to send
  - closeGracefully
```
public void closeGracefully()
```
    Close the server gracefully.
  - close
```
public void close()
```
    Close the server immediately.
  - getAsyncServer
```
public McpAsyncServer getAsyncServer()
```
    Get the underlying async server instance.
    
    返回:
    
    The wrapped async server

类 McpSyncServer

构造器概要

方法概要

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

构造器详细资料

McpSyncServer

方法详细资料

addTool

removeTool

addResource

removeResource

addResourceTemplate

removeResourceTemplate

addPrompt

removePrompt

notifyToolsListChanged

getServerCapabilities

getServerInfo

notifyResourcesListChanged

notifyPromptsListChanged

loggingNotification

closeGracefully

close

getAsyncServer