概述
MCP 服务器是模型上下文协议 (MCP) 架构中的基础组件,为客户端提供工具、资源和能力。它实现了协议的服务器端部分,负责:- 暴露客户端可以发现和执行的工具
- 管理具有基于 URI 的访问模式的资源
- 提供提示模板并处理提示请求
- 支持与客户端的能力协商
- 实现服务器端协议操作
- 管理并发客户端连接
- 提供结构化日志记录和通知
- 同步 API
- 异步 API
Copy
// 创建具有自定义配置的服务器
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();
Copy
// 创建具有自定义配置的异步服务器
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 包含几个内置的传输实现:- 标准输入输出
- SSE (WebFlux)
- SSE (WebMvc)
- SSE (Servlet)
创建基于进程内的传输:通过标准输入/输出流提供双向 JSON-RPC 消息处理,具有非阻塞消息处理、序列化/反序列化和优雅关闭支持。主要特点:
Copy
StdioServerTransport transport = new StdioServerTransport(new ObjectMapper());
- 通过 stdin/stdout 的双向通信
- 基于进程的集成支持
- 简单的设置和配置
- 轻量级实现
创建基于 WebFlux 的 SSE 服务器传输。
需要 mcp-spring-webflux 依赖。
Copy
@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 依赖。
Copy
@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:
Copy
@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) 用于服务器到客户端的事件 - 消息端点(可配置)用于客户端到服务器的请求
- SSE 端点 (
- 错误处理和响应格式化
- 优雅关闭支持
服务器能力
服务器可以配置各种能力:Copy
var capabilities = ServerCapabilities.builder()
.resources(false, true) // 资源支持,带列表变更通知
.tools(true) // 工具支持,带列表变更通知
.prompts(true) // 提示支持,带列表变更通知
.logging() // 启用日志支持(默认启用,日志级别为 INFO)
.build();
日志支持
服务器提供结构化日志功能,允许向客户端发送不同严重级别的日志消息:Copy
// 向客户端发送日志消息
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)
工具注册
- 同步
- 异步
Copy
// 同步工具注册
var syncToolRegistration = new McpServerFeatures.SyncToolRegistration(
new Tool("calculator", "基础计算器", Map.of(
"operation", "string",
"a", "number",
"b", "number"
)),
arguments -> {
// 工具实现
return new CallToolResult(result, false);
}
);
Copy
// 异步工具注册
var asyncToolRegistration = new McpServerFeatures.AsyncToolRegistration(
new Tool("calculator", "基础计算器", Map.of(
"operation", "string",
"a", "number",
"b", "number"
)),
arguments -> {
// 工具实现
return Mono.just(new CallToolResult(result, false));
}
);
资源注册
- 同步
- 异步
Copy
// 同步资源注册
var syncResourceRegistration = new McpServerFeatures.SyncResourceRegistration(
new Resource("custom://resource", "名称", "描述", "mime-type", null),
request -> {
// 资源读取实现
return new ReadResourceResult(contents);
}
);
Copy
// 异步资源注册
var asyncResourceRegistration = new McpServerFeatures.AsyncResourceRegistration(
new Resource("custom://resource", "名称", "描述", "mime-type", null),
request -> {
// 资源读取实现
return Mono.just(new ReadResourceResult(contents));
}
);
提示注册
- 同步
- 异步
Copy
// 同步提示注册
var syncPromptRegistration = new McpServerFeatures.SyncPromptRegistration(
new Prompt("greeting", "描述", List.of(
new PromptArgument("name", "描述", true)
)),
request -> {
// 提示实现
return new GetPromptResult(description, messages);
}
);
Copy
// 异步提示注册
var asyncPromptRegistration = new McpServerFeatures.AsyncPromptRegistration(
new Prompt("greeting", "描述", List.of(
new PromptArgument("name", "描述", true)
)),
request -> {
// 提示实现
return Mono.just(new GetPromptResult(description, messages));
}
);