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, boolean immediateExecution)` 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 resourceSpecification)` Add a new resource handler.
`void`	`addResourceTemplate(McpServerFeatures.SyncResourceTemplateSpecification resourceTemplateSpecification)` Add a new resource template.
`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.
`java.util.List<McpSchema.Prompt>`	`listPrompts()` List all registered prompts.
`java.util.List<McpSchema.Resource>`	`listResources()` List all registered resources.
`java.util.List<McpSchema.ResourceTemplate>`	`listResourceTemplates()` List all registered resource templates.
`java.util.List<McpSchema.Tool>`	`listTools()` List all registered tools.
`void`	`loggingNotification(McpSchema.LoggingMessageNotification loggingMessageNotification)` 已过时。 Use `McpSyncServerExchange#loggingNotification(LoggingMessageNotification)` instead.
`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`	`notifyResourcesUpdated(McpSchema.ResourcesUpdatedNotification resourcesUpdatedNotification)` Notify clients that the resources have updated.
`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 uriTemplate)` Remove a resource template.
`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
  - McpSyncServer
```
public McpSyncServer(McpAsyncServer asyncServer,
                     boolean immediateExecution)
```
    Creates a new synchronous server that wraps the provided async server.
    
    参数:
    
    asyncServer - The async server to wrap
    
    immediateExecution - Tools, prompts, and resources handlers execute work without blocking code offloading. Do NOT set to true if the asyncServer's transport is non-blocking.
- 方法详细资料
  - addTool
```
public void addTool(McpServerFeatures.SyncToolSpecification toolHandler)
```
    Add a new tool handler.
    
    参数:
    
    toolHandler - The tool handler to add
  - listTools
```
public java.util.List<McpSchema.Tool> listTools()
```
    List all registered tools.
    
    返回:
    
    A list of all registered tools
  - 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 resourceSpecification)
```
    Add a new resource handler.
    
    参数:
    
    resourceSpecification - The resource specification to add
  - listResources
```
public java.util.List<McpSchema.Resource> listResources()
```
    List all registered resources.
    
    返回:
    
    A list of all registered resources
  - 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 resourceTemplateSpecification)
```
    Add a new resource template.
    
    参数:
    
    resourceTemplateSpecification - The resource template specification to add
  - listResourceTemplates
```
public java.util.List<McpSchema.ResourceTemplate> listResourceTemplates()
```
    List all registered resource templates.
    
    返回:
    
    A list of all registered resource templates
  - removeResourceTemplate
```
public void removeResourceTemplate(java.lang.String uriTemplate)
```
    Remove a resource template.
    
    参数:
    
    uriTemplate - The URI template of the resource template to remove
  - addPrompt
```
public void addPrompt(McpServerFeatures.SyncPromptSpecification promptSpecification)
```
    Add a new prompt handler.
    
    参数:
    
    promptSpecification - The prompt specification to add
  - listPrompts
```
public java.util.List<McpSchema.Prompt> listPrompts()
```
    List all registered prompts.
    
    返回:
    
    A list of all registered prompts
  - 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.
  - notifyResourcesUpdated
```
public void notifyResourcesUpdated(McpSchema.ResourcesUpdatedNotification resourcesUpdatedNotification)
```
    Notify clients that the resources have updated.
  - notifyPromptsListChanged
```
public void notifyPromptsListChanged()
```
    Notify clients that the list of available prompts has changed.
  - loggingNotification
```
@Deprecated
public void loggingNotification(McpSchema.LoggingMessageNotification loggingMessageNotification)
```
    已过时。 Use McpSyncServerExchange#loggingNotification(LoggingMessageNotification) instead.
    
    This implementation would, incorrectly, broadcast the logging message to all connected clients, using a single minLoggingLevel for all of them. Similar to the sampling and roots, the logging level should be set per client session and use the ServerExchange to send the logging message to the right client.
    
    参数:
    
    loggingMessageNotification - The logging message 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

McpSyncServer

方法详细资料

addTool

listTools

removeTool

addResource

listResources

removeResource

addResourceTemplate

listResourceTemplates

removeResourceTemplate

addPrompt

listPrompts

removePrompt

notifyToolsListChanged

getServerCapabilities

getServerInfo

notifyResourcesListChanged

notifyResourcesUpdated

notifyPromptsListChanged

loggingNotification

closeGracefully

close

getAsyncServer