Spring AI / Model Context Protocol (MCP) / MCP Server Boot Starters / STDIO and SSE MCP Servers
Spring AI MCP 服务器启动器
概述
Spring AI 提供了多种 Model Context Protocol (MCP) 服务器启动器,支持不同的传输机制。
STDIO 和 SSE MCP 服务器
STDIO 和 SSE MCP 服务器支持多种传输机制,每种都有专用的启动器。
使用 STDIO 客户端或 SSE 客户端连接到 STDIO 和 SSE 服务器。
STDIO MCP 服务器
具有 STDIO 服务器传输的完整 MCP 服务器功能支持。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server</artifactId>
</dependency>
- 适用于命令行和桌面工具
- 无需额外的 Web 依赖
- 基本服务器组件的配置
- 处理工具、资源和提示规范
- 管理服务器功能和变更通知
- 支持同步和异步服务器实现
SSE WebMVC 服务器
基于 Spring MVC 的 SSE(服务器发送事件)服务器传输的完整 MCP 服务器功能支持,并提供可选的 STDIO 传输。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server-webmvc</artifactId>
</dependency>
- 使用 Spring MVC 的 HTTP 传输(WebMvcSseServerTransportProvider)
- 自动配置的 SSE 端点
- 可选的 STDIO 传输(通过设置
spring.ai.mcp.server.stdio=true启用) - 包含
spring-boot-starter-web和org.springframework.ai:mcp-spring-webmvc依赖
SSE WebFlux 服务器
基于 Spring WebFlux 的 SSE 服务器传输的完整 MCP 服务器功能支持,并提供可选的 STDIO 传输。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server-webflux</artifactId>
</dependency>
该启动器激活 McpWebFluxServerAutoConfiguration 和 McpServerAutoConfiguration 自动配置,提供:
- 使用 Spring WebFlux 的响应式传输(WebFluxSseServerTransportProvider)
- 自动配置的响应式 SSE 端点
- 可选的 STDIO 传输(通过设置
spring.ai.mcp.server.stdio=true启用) - 包含
spring-boot-starter-webflux和org.springframework.ai:mcp-spring-webflux依赖
注意:由于 Spring Boot 的默认行为,当
org.springframework.web.servlet.DispatcherServlet和org.springframework.web.reactive.DispatcherHandler同时存在于类路径中时,Spring Boot 会优先使用DispatcherServlet。因此,如果您的项目使用了spring-boot-starter-web,建议使用spring-ai-starter-mcp-server-webmvc而不是spring-ai-starter-mcp-server-webflux。
配置属性
通用属性
所有通用属性前缀为 spring.ai.mcp.server:
| 属性 | 描述 | 默认值 |
|---|---|---|
enabled |
启用/禁用 MCP 服务器 | true |
tool-callback-converter |
启用/禁用将 Spring AI ToolCallback 转换为 MCP Tool 规范 | true |
stdio |
启用/禁用 STDIO 传输 | false |
name |
服务器标识名称 | mcp-server |
version |
服务器版本 | 1.0.0 |
instructions |
可选说明,为客户端提供如何与该服务器交互的指导 | null |
type |
服务器类型(SYNC/ASYNC) | SYNC |
capabilities.resource |
启用/禁用资源功能 | true |
capabilities.tool |
启用/禁用工具功能 | true |
capabilities.prompt |
启用/禁用提示功能 | true |
capabilities.completion |
启用/禁用补全功能 | true |
resource-change-notification |
启用资源变更通知 | true |
prompt-change-notification |
启用提示变更通知 | true |
tool-change-notification |
启用工具变更通知 | true |
expose-mcp-client-tools |
是否将下游 MCP 工具(由 MCP 客户端提供)重新暴露为此 MCP 服务器的工具 | false |
tool-response-mime-type |
按工具名称指定的可选响应 MIME 类型。例如,spring.ai.mcp.server.tool-response-mime-type.generateImage=image/png 将 image/png MIME 类型与 generateImage() 工具名称关联 |
- |
request-timeout |
等待服务器响应超时的时间。适用于客户端发起的所有请求,包括工具调用、资源访问和提示操作 | 20秒 |
MCP 注解属性
MCP 服务器注解提供了一种使用 Java 注解实现 MCP 服务器处理器的声明式方式。
服务器 mcp-annotations 属性前缀为 spring.ai.mcp.server.annotation-scanner:
| 属性 | 描述 | 默认值 |
|---|---|---|
enabled |
启用/禁用 MCP 服务器注解自动扫描 | true |
SSE 属性
所有 SSE 属性前缀为 spring.ai.mcp.server:
| 属性 | 描述 | 默认值 |
|---|---|---|
sse-message-endpoint |
Web 传输的自定义 SSE 消息端点,供客户端发送消息 | /mcp/message |
sse-endpoint |
Web 传输的自定义 SSE 端点 | /sse |
base-url |
可选的 URL 前缀。例如,base-url=/api/v1 表示客户端应访问 /api/v1 + sse-endpoint 的 SSE 端点,消息端点为 /api/v1 + sse-message-endpoint |
- |
keep-alive-interval |
连接保活间隔 | null(禁用) |
为了向后兼容,SSE 属性没有额外的后缀(如
.sse)。
功能和能力
MCP 服务器启动器允许服务器向客户端暴露工具、资源和提示。它会根据服务器类型,自动将注册为 Spring Bean 的自定义能力处理器转换为同步/异步规范:
工具
允许服务器暴露可供语言模型调用的工具。MCP 服务器启动器提供:
- 变更通知支持
- Spring AI 工具根据服务器类型自动转换为同步/异步规范
- 通过 Spring Bean 自动指定工具:
@Bean
public ToolCallbackProvider myTools(...) {
List<ToolCallback> tools = ...
return ToolCallbackProvider.from(tools);
}
或使用低级 API:
@Bean
public List<McpServerFeatures.SyncToolSpecification> myTools(...) {
List<McpServerFeatures.SyncToolSpecification> tools = ...
return tools;
}
自动配置会自动检测并注册所有工具回调,来源包括:
- 单个
ToolCallbackBean ToolCallbackBean 列表ToolCallbackProviderBean
工具按名称去重,每个工具名称只使用第一个出现项。
您可以通过将 tool-callback-converter 设置为 false 来禁用所有工具回调的自动检测和注册。
工具上下文支持
支持 ToolContext,允许将上下文信息传递给工具调用。它包含一个 McpSyncServerExchange 实例,可通过 exchange 键访问,使用 McpToolUtils.getMcpExchange(toolContext) 获取。请参阅此示例,演示了 exchange.loggingNotification(...) 和 exchange.createMessage(...)。
资源
为服务器提供了一种向客户端暴露资源的标准方式。
- 静态和动态资源规范
- 可选的变更通知
- 支持资源模板
- 同步和异步资源规范之间的自动转换
通过 Spring Bean 自动指定资源:
@Bean
public List<McpServerFeatures.SyncResourceSpecification> myResources(...) {
var systemInfoResource = new McpSchema.Resource(...);
var resourceSpecification = new McpServerFeatures.SyncResourceSpecification(systemInfoResource, (exchange, request) -> {
try {
var systemInfo = Map.of(...);
String jsonContent = new JsonMapper().writeValueAsString(systemInfo);
return new McpSchema.ReadResourceResult(
List.of(new McpSchema.TextResourceContents(request.uri(), "application/json", jsonContent)));
}
catch (Exception e) {
throw new RuntimeException("Failed to generate system info", e);
}
});
return List.of(resourceSpecification);
}
提示
为服务器提供了一种向客户端暴露提示模板的标准方式。
- 变更通知支持
- 模板版本控制
- 同步和异步提示规范之间的自动转换
通过 Spring Bean 自动指定提示:
@Bean
public List<McpServerFeatures.SyncPromptSpecification> myPrompts() {
var prompt = new McpSchema.Prompt("greeting", "A friendly greeting prompt",
List.of(new McpSchema.PromptArgument("name", "The name to greet", true)));
var promptSpecification = new McpServerFeatures.SyncPromptSpecification(prompt, (exchange, getPromptRequest) -> {
String nameArgument = (String) getPromptRequest.arguments().get("name");
if (nameArgument == null) { nameArgument = "friend"; }
var userMessage = new PromptMessage(Role.USER, TextContent.builder("Hello " + nameArgument + "! How can I assist you today?").build());
return GetPromptResult.builder(List.of(userMessage)).description("A personalized greeting message").build();
});
return List.of(promptSpecification);
}
补全
为服务器提供了一种向客户端暴露补全功能的标准方式。
- 支持同步和异步补全规范
- 通过 Spring Bean 自动注册:
@Bean
public List<McpServerFeatures.SyncCompletionSpecification> myCompletions() {
var completion = new McpServerFeatures.SyncCompletionSpecification(
new McpSchema.PromptReference(
"ref/prompt", "code-completion", "Provides code completion suggestions"),
(exchange, request) -> {
// 返回补全建议的实现
return new McpSchema.CompleteResult(List.of("python", "pytorch", "pyside"), 10, true);
}
);
return List.of(completion);
}
日志记录
为服务器提供了一种向客户端发送结构化日志消息的标准方式。在工具、资源、提示或补全调用处理器中,使用提供的 McpSyncServerExchange/McpAsyncServerExchange 交换对象发送日志消息:
(exchange, request) -> {
exchange.loggingNotification(LoggingMessageNotification.builder(LoggingLevel.INFO, "This is a test log message")
.logger("test-logger")
.build());
}
在 MCP 客户端,您可以注册日志消费者来处理这些消息:
mcpClientSpec.loggingConsumer((McpSchema.LoggingMessageNotification log) -> {
// 处理日志消息
});
进度
为服务器提供了一种向客户端发送进度更新的标准方式。在工具、资源、提示或补全调用处理器中,使用提供的 McpSyncServerExchange/McpAsyncServerExchange 交换对象发送进度通知:
(exchange, request) -> {
exchange.progressNotification(ProgressNotification.builder("test-progress-token", 0.25)
.total(1.0)
.message("tool call in progress")
.build());
}
MCP 客户端可以接收进度通知并相应地更新其 UI。为此,需要注册一个进度消费者:
mcpClientSpec.progressConsumer((McpSchema.ProgressNotification progress) -> {
// 处理进度通知
});
根列表变更
当根发生变化时,支持 listChanged 的客户端会发送根变更通知。
- 支持监控根变更
- 自动转换为响应式应用程序的异步消费者
- 可通过 Spring Bean 可选注册:
@Bean
public BiConsumer<McpSyncServerExchange, List<McpSchema.Root>> rootsChangeHandler() {
return (exchange, roots) -> {
logger.info("Registering root resources: {}", roots);
};
}
Ping
服务器 Ping 机制,用于验证其客户端是否仍然存活。在工具、资源、提示或补全调用处理器中,使用提供的 McpSyncServerExchange/McpAsyncServerExchange 交换对象发送 Ping 消息:
(exchange, request) -> {
exchange.ping();
}
保活
服务器可以可选地定期向已连接的客户端发送 Ping,以验证连接健康状态。
默认情况下,保活功能是禁用的。要启用保活功能,请在配置中设置 keep-alive-interval 属性:
spring:
ai:
mcp:
server:
keep-alive-interval: 30s
使用示例
标准 STDIO 服务器配置
# 使用 spring-ai-starter-mcp-server
spring:
ai:
mcp:
server:
name: stdio-mcp-server
version: 1.0.0
type: SYNC
WebMVC 服务器配置
# 使用 spring-ai-starter-mcp-server-webmvc
spring:
ai:
mcp:
server:
name: webmvc-mcp-server
version: 1.0.0
type: SYNC
instructions: "该服务器提供天气信息工具和资源"
capabilities:
tool: true
resource: true
prompt: true
completion: true
# sse 属性
sse-message-endpoint: /mcp/messages
keep-alive-interval: 30s
WebFlux 服务器配置
# 使用 spring-ai-starter-mcp-server-webflux
spring:
ai:
mcp:
server:
name: webflux-mcp-server
version: 1.0.0
type: ASYNC # 推荐用于响应式应用程序
instructions: "该响应式服务器提供天气信息工具和资源"
capabilities:
tool: true
resource: true
prompt: true
completion: true
# sse 属性
sse-message-endpoint: /mcp/messages
keep-alive-interval: 30s
创建带有 MCP 服务器的 Spring Boot 应用程序
@Service
public class WeatherService {
@Tool(description = "根据城市名称获取天气信息")
public String getWeather(String cityName) {
// 实现逻辑
}
}
@SpringBootApplication
public class McpServerApplication {
private static final Logger logger = LoggerFactory.getLogger(McpServerApplication.class);
public static void main(String[] args) {
SpringApplication.run(McpServerApplication.class, args);
}
@Bean
public ToolCallbackProvider weatherTools(WeatherService weatherService) {
return MethodToolCallbackProvider.builder().toolObjects(weatherService).build();
}
}
自动配置会自动将工具回调注册为 MCP 工具。您可以有多个生成 ToolCallback 的 Bean,自动配置会将它们合并。
示例应用程序
- Weather Server (WebFlux) - 使用 WebFlux 传输的 Spring AI MCP 服务器启动器
- Weather Server (STDIO) - 使用 STDIO 传输的 Spring AI MCP 服务器启动器
- Weather Server Manual Configuration - 不使用自动配置,而是使用 Java SDK 手动配置服务器的 Spring AI MCP 服务器启动器
更多推荐

所有评论(0)