MCP服务器是模型上下文协议(MCP协议)架构中的基础组件,为客户端提供工具、资源和能力。它实现了协议的服务器端部分,负责:
- 暴露客户端可以发现和执行的工具
- 使用基于URI的访问模式管理资源
- 提供提示模板并处理提示请求
- 支持与客户端的能力协商
- 实现服务器端协议操作
- 管理并发客户端连接
- 提供结构化日志和通知
服务器支持同步和异步API,允许在不同的应用场景中灵活集成。
// 使用自定义配置创建服务器
McpSyncServer syncServer = McpServer.sync(transport)
.serverInfo("my-server", "1.0.0")
.capabilities(ServerCapabilities.builder()
.resources(true) // 启用资源支持
.tools(true) // 启用工具支持
.prompts(true) // 启用提示支持
.logging() // 启用日志支持
.build())
.build();
// 注册工具、资源和提示
syncServer.addTool(syncToolRegistration);
syncServer.addResource(syncResourceRegistration);
syncServer.addPrompt(syncPromptRegistration);
// 发送日志通知
syncServer.loggingNotification(LoggingMessageNotification.builder()
.level(LoggingLevel.INFO)
.logger("custom-logger")
.data("服务器已初始化")
.build());
// 完成后关闭服务器
syncServer.close();
// 使用自定义配置创建服务器
McpSyncServer syncServer = McpServer.sync(transport)
.serverInfo("my-server", "1.0.0")
.capabilities(ServerCapabilities.builder()
.resources(true) // 启用资源支持
.tools(true) // 启用工具支持
.prompts(true) // 启用提示支持
.logging() // 启用日志支持
.build())
.build();
// 注册工具、资源和提示
syncServer.addTool(syncToolRegistration);
syncServer.addResource(syncResourceRegistration);
syncServer.addPrompt(syncPromptRegistration);
// 发送日志通知
syncServer.loggingNotification(LoggingMessageNotification.builder()
.level(LoggingLevel.INFO)
.logger("custom-logger")
.data("服务器已初始化")
.build());
// 完成后关闭服务器
syncServer.close();
// 使用自定义配置创建异步服务器
McpAsyncServer asyncServer = McpServer.async(transport)
.serverInfo("my-server", "1.0.0")
.capabilities(ServerCapabilities.builder()
.resources(true) // 启用资源支持
.tools(true) // 启用工具支持
.prompts(true) // 启用提示支持
.logging() // 启用日志支持
.build())
.build();
// 注册工具、资源和提示
asyncServer.addTool(asyncToolRegistration)
.doOnSuccess(v -> logger.info("工具已注册"))
.subscribe();
asyncServer.addResource(asyncResourceRegistration)
.doOnSuccess(v -> logger.info("资源已注册"))
.subscribe();
asyncServer.addPrompt(asyncPromptRegistration)
.doOnSuccess(v -> logger.info("提示已注册"))
.subscribe();
// 发送日志通知
asyncServer.loggingNotification(LoggingMessageNotification.builder()
.level(LoggingLevel.INFO)
.logger("custom-logger")
.data("服务器已初始化")
.build());
// 完成后关闭服务器
asyncServer.close()
.doOnSuccess(v -> logger.info("服务器已关闭"))
.subscribe();
服务器传输
MCP SDK中的传输层负责处理客户端与服务器之间的通信。它提供了不同的实现以支持各种通信协议和模式。SDK包括多种内置的传输实现:
创建基于进程的传输:
StdioServerTransport transport = new StdioServerTransport(new ObjectMapper());
通过标准输入/输出流提供双向JSON-RPC消息处理,支持非阻塞消息处理、序列化/反序列化和优雅关闭。
关键特性:
- 通过stdin/stdout进行双向通信
- 支持基于进程的集成
- 简单的设置和配置
- 轻量级实现
创建基于进程的传输:
StdioServerTransport transport = new StdioServerTransport(new ObjectMapper());
通过标准输入/输出流提供双向JSON-RPC消息处理,支持非阻塞消息处理、序列化/反序列化和优雅关闭。
关键特性:
- 通过stdin/stdout进行双向通信
- 支持基于进程的集成
- 简单的设置和配置
- 轻量级实现
创建基于WebFlux的SSE服务器传输。
需要mcp-spring-webflux
依赖。
@Configuration
class McpConfig {
@Bean
WebFluxSseServerTransport webFluxSseServerTransport(ObjectMapper mapper) {
return new WebFluxSseServerTransport(mapper, "/mcp/message");
}
@Bean
RouterFunction<?> mcpRouterFunction(WebFluxSseServerTransport transport) {
return transport.getRouterFunction();
}
}
实现MCP HTTP与SSE传输规范,提供:
- 使用WebFlux的响应式HTTP流
- 通过SSE端点支持并发客户端连接
- 消息路由和会话管理
- 优雅关闭能力
创建基于WebMvc的SSE服务器传输。
需要mcp-spring-webmvc
依赖。
@Configuration
@EnableWebMvc
class McpConfig {
@Bean
WebMvcSseServerTransport webMvcSseServerTransport(ObjectMapper mapper) {
return new WebMvcSseServerTransport(mapper, "/mcp/message");
}
@Bean
RouterFunction<ServerResponse> mcpRouterFunction(WebMvcSseServerTransport transport) {
return transport.getRouterFunction();
}
}
实现MCP HTTP与SSE传输规范,提供:
- 服务器端事件流
- 与Spring WebMVC集成
- 支持传统Web应用程序
- 同步操作处理
创建一个基于Servlet的SSE服务器传输。它包含在核心mcp
模块中。
HttpServletSseServerTransport
可以与任何Servlet容器一起使用。
要在Spring Web应用程序中使用它,可以将其注册为Servlet bean:
@Configuration
@EnableWebMvc
public class McpServerConfig implements WebMvcConfigurer {
@Bean
public HttpServletSseServerTransport servletSseServerTransport() {
return new HttpServletSseServerTransport(new ObjectMapper(), "/mcp/message");
}
@Bean
public ServletRegistrationBean customServletBean(HttpServletSseServerTransport servlet) {
return new ServletRegistrationBean(servlet);
}
}
使用传统的Servlet API实现MCP HTTP与SSE传输规范,提供:
- 使用Servlet 6.0异步支持进行异步消息处理
- 管理多个客户端连接的会话
两种类型的端点:
- SSE端点(
/sse
)用于服务器到客户端的事件 - 消息端点(可配置)用于客户端到服务器的请求
- 错误处理和响应格式化
- 优雅关闭支持
服务器能力
服务器可以配置多种能力:
var capabilities = ServerCapabilities.builder()
.resources(false, true) // 资源支持及列表变更通知
.tools(true) // 工具支持及列表变更通知
.prompts(true) // 提示支持及列表变更通知
.logging() // 启用日志支持(默认启用,日志级别为INFO)
.build();
日志支持
服务器提供结构化日志功能,允许向客户端发送不同严重级别的日志消息:
// 向客户端发送日志消息
server.loggingNotification(LoggingMessageNotification.builder()
.level(LoggingLevel.INFO)
.logger("custom-logger")
.data("自定义日志消息")
.build());
客户端可以通过mcpClient.setLoggingLevel(level)
请求控制接收的最低日志级别。低于设置级别的消息将被过滤掉。
支持的日志级别(按严重程度递增):DEBUG (0), INFO (1), NOTICE (2), WARNING (3), ERROR (4), CRITICAL (5), ALERT (6), EMERGENCY (7)
工具注册
// 同步工具注册
var schema = """
{
"type" : "object",
"id" : "urn:jsonschema:Operation",
"properties" : {
"operation" : {
"type" : "string"
},
"a" : {
"type" : "number"
},
"b" : {
"type" : "number"
}
}
}
""";
var syncToolRegistration = new McpServerFeatures.SyncToolRegistration(
new Tool("calculator", "基本计算器", schema),
arguments -> {
// 工具实现
return new CallToolResult(result, false);
}
);
// 同步工具注册
var schema = """
{
"type" : "object",
"id" : "urn:jsonschema:Operation",
"properties" : {
"operation" : {
"type" : "string"
},
"a" : {
"type" : "number"
},
"b" : {
"type" : "number"
}
}
}
""";
var syncToolRegistration = new McpServerFeatures.SyncToolRegistration(
new Tool("calculator", "基本计算器", schema),
arguments -> {
// 工具实现
return new CallToolResult(result, false);
}
);
// 异步工具注册
var schema = """
{
"type" : "object",
"id" : "urn:jsonschema:Operation",
"properties" : {
"operation" : {
"type" : "string"
},
"a" : {
"type" : "number"
},
"b" : {
"type" : "number"
}
}
}
""";
var asyncToolRegistration = new McpServerFeatures.AsyncToolRegistration(
new Tool("calculator", "基本计算器", schema),
arguments -> {
// 工具实现
return Mono.just(new CallToolResult(result, false));
}
);
资源注册
// 同步资源注册
var syncResourceRegistration = new McpServerFeatures.SyncResourceRegistration(
new Resource("custom://resource", "name", "description", "mime-type", null),
request -> {
// 资源读取实现
return new ReadResourceResult(contents);
}
);
// 同步资源注册
var syncResourceRegistration = new McpServerFeatures.SyncResourceRegistration(
new Resource("custom://resource", "name", "description", "mime-type", null),
request -> {
// 资源读取实现
return new ReadResourceResult(contents);
}
);
// 异步资源注册
var asyncResourceRegistration = new McpServerFeatures.AsyncResourceRegistration(
new Resource("custom://resource", "name", "description", "mime-type", null),
request -> {
// 资源读取实现
return Mono.just(new ReadResourceResult(contents));
}
);
提示注册
// 同步提示注册
var syncPromptRegistration = new McpServerFeatures.SyncPromptRegistration(
new Prompt("greeting", "description", List.of(
new PromptArgument("name", "description", true)
)),
request -> {
// 提示实现
return new GetPromptResult(description, messages);
}
);
// 同步提示注册
var syncPromptRegistration = new McpServerFeatures.SyncPromptRegistration(
new Prompt("greeting", "description", List.of(
new PromptArgument("name", "description", true)
)),
request -> {
// 提示实现
return new GetPromptResult(description, messages);
}
);
// 异步提示注册
var asyncPromptRegistration = new McpServerFeatures.AsyncPromptRegistration(
new Prompt("greeting", "description", List.of(
new PromptArgument("name", "description", true)
)),
request -> {
// 提示实现
return Mono.just(new GetPromptResult(description, messages));
}
);
错误处理
SDK通过McpError类提供全面的错误处理,涵盖协议兼容性、传输通信、JSON-RPC消息、工具执行、资源管理、提示处理、超时和连接问题。这种统一的错误处理方法确保在同步和异步操作中一致且可靠的错误管理。