|
此版本仍在开发中,尚未被视为稳定版。如需最新的快照版本,请使用 Spring AI 1.1.3! |
STDIO 和 SSE MCP 服务器
STDIO 和 SSE MCP 服务器支持多种传输机制,每种机制都有其专用的Starters。
STDIO MCP 服务器
通过 STDIO 服务器传输实现完整的 MCP 服务器功能支持。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server</artifactId>
</dependency>
-
适用于命令行和桌面工具
-
无需额外的 Web 依赖
-
基本服务器组件的配置
-
工具、资源和提示规范的处理
-
服务器功能管理与变更通知
-
支持同步和异步服务器实现
SSE WebMVC 服务器
基于 Spring MVC 的 SSE(服务器发送事件)服务器传输以及可选的 STDIO 传输,提供完整的 MCP 服务器功能支持。
<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(服务器发送事件)服务器传输以及可选的 STDIO 传输,提供完整的 MCP 服务器功能支持。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server-webflux</artifactId>
</dependency>
该Starters激活 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 的默认行为,当类路径中同时存在 |
配置属性
常用属性
所有通用属性均以 spring.ai.mcp.server 为前缀:
| <property> </property> | <description> </description> | 默认 |
|---|---|---|
|
启用/禁用 MCP 服务器 |
|
|
启用/禁用将 Spring AI ToolCallbacks 转换为 MCP Tool 规范的功能 |
|
|
启用/禁用标准输入输出传输 |
|
|
用于识别的服务器名称 |
|
|
服务器版本 |
|
|
提供指导客户端如何与此服务器交互的可选说明 |
|
|
服务器类型(同步/异步) |
|
|
启用/禁用资源功能 |
|
|
启用/禁用工具功能 |
|
|
启用/禁用提示功能 |
|
|
启用/禁用代码补全功能 |
|
|
启用资源变更通知 |
|
|
启用提示更改通知 |
|
|
启用工具变更通知 |
|
|
每个工具名称的可选响应 MIME 类型。例如, |
|
|
在请求超时前等待服务器响应的持续时间。适用于通过客户端发出的所有请求,包括工具调用、资源访问和提示操作。 |
|
MCP 注解属性
MCP Server Annotations 提供了一种使用 Java 注解以声明式方式实现 MCP 服务器处理程序的方法。
服务器 mcp-annotations 的属性以 spring.ai.mcp.server.annotation-scanner 为前缀:
| <property> </property> | <description> </description> | 默认值 |
|---|---|---|
|
启用/禁用 MCP 服务器注解的自动扫描 |
|
SSE 属性
所有 SSE 属性均以 spring.ai.mcp.server 为前缀:
| <property> </property> | <description> </description> | 默认 |
|---|---|---|
|
用于 Web 传输的自定义 SSE 消息端点路径,供客户端发送消息使用 |
|
|
用于 Web 传输的自定义 SSE 端点路径 |
|
|
可选的 URL 前缀。例如, |
|
|
连接保持活动间隔 |
|
出于向后兼容性的原因,SSE 属性没有额外的后缀(如 .sse)。 |
功能与能力
MCP Server Boot Starter 允许服务器向客户端暴露工具、资源和提示。 它会根据服务器类型,自动将注册为 Spring Bean 的自定义能力处理器转换为同步/异步规范:
工具
允许服务器暴露可由语言模型调用的工具。MCP Server Boot Starter 提供:
-
变更通知支持
-
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;
}
自动配置将自动检测并注册来自以下位置的所有工具回调:
-
单个
ToolCallback个 Bean -
ToolCallback个 Bean 的列表 -
ToolCallbackProvider个 Bean
工具按名称去重,使用每个工具名称首次出现的实例。
您可以通过将 tool-callback-converter 设置为 false 来禁用所有工具回调的自动检测和注册。 |
工具上下文支持
支持 ToolContext,允许将上下文信息传递给工具调用。它在 exchange 键下包含一个 McpSyncServerExchange 实例,可通过 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, new TextContent("Hello " + nameArgument + "! How can I assist you today?"));
return new GetPromptResult("A personalized greeting message", List.of(userMessage));
});
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) -> {
// Implementation that returns completion suggestions
return new McpSchema.CompleteResult(List.of("python", "pytorch", "pyside"), 10, true);
}
);
return List.of(completion);
}
日志记录
为服务器向客户端发送结构化日志消息提供了一种标准化方式。
在工具、资源、提示或完成调用处理程序中,使用提供的 McpSyncServerExchange/McpAsyncServerExchange exchange 对象来发送日志消息:
(exchange, request) -> {
exchange.loggingNotification(LoggingMessageNotification.builder()
.level(LoggingLevel.INFO)
.logger("test-logger")
.data("This is a test log message")
.build());
}
在 MCP 客户端上,您可以注册 日志消费者 来处理这些消息:
mcpClientSpec.loggingConsumer((McpSchema.LoggingMessageNotification log) -> {
// Handle log messages
});
进展
为服务器向客户端发送进度更新提供了一种标准化方式。
在工具、资源、提示或完成调用处理程序中,使用提供的 McpSyncServerExchange/McpAsyncServerExchange exchange 对象来发送进度通知:
(exchange, request) -> {
exchange.progressNotification(ProgressNotification.builder()
.progressToken("test-progress-token")
.progress(0.25)
.total(1.0)
.message("tool call in progress")
.build());
}
Mcp 客户端可以接收进度通知并相应地更新其用户界面。 为此,它需要注册一个进度消费者。
mcpClientSpec.progressConsumer((McpSchema.ProgressNotification progress) -> {
// Handle progress notifications
});
根列表变更
当根节点发生变化时,支持 listChanged 的客户端会发送根节点变更通知。
-
支持监控根目录变更
-
为响应式应用自动转换为异步消费者
-
通过 Spring Bean 进行可选注册
@Bean
public BiConsumer<McpSyncServerExchange, List<McpSchema.Root>> rootsChangeHandler() {
return (exchange, roots) -> {
logger.info("Registering root resources: {}", roots);
};
}
PING
服务器用于验证其客户端是否仍然存活的机制。
在工具、资源、提示或完成调用处理程序中,使用提供的 McpSyncServerExchange/McpAsyncServerExchange exchange 对象来发送心跳消息:
(exchange, request) -> {
exchange.ping();
}
使用示例
标准 STDIO 服务器配置
# Using spring-ai-starter-mcp-server
spring:
ai:
mcp:
server:
name: stdio-mcp-server
version: 1.0.0
type: SYNC
WebMVC 服务器配置
# Using spring-ai-starter-mcp-server-webmvc
spring:
ai:
mcp:
server:
name: webmvc-mcp-server
version: 1.0.0
type: SYNC
instructions: "This server provides weather information tools and resources"
capabilities:
tool: true
resource: true
prompt: true
completion: true
# sse properties
sse-message-endpoint: /mcp/messages
keep-alive-interval: 30s
WebFlux 服务器配置
# Using spring-ai-starter-mcp-server-webflux
spring:
ai:
mcp:
server:
name: webflux-mcp-server
version: 1.0.0
type: ASYNC # Recommended for reactive applications
instructions: "This reactive server provides weather information tools and resources"
capabilities:
tool: true
resource: true
prompt: true
completion: true
# sse properties
sse-message-endpoint: /mcp/messages
keep-alive-interval: 30s
使用 MCP 服务器创建 Spring Boot 应用程序
@Service
public class WeatherService {
@Tool(description = "Get weather information by city name")
public String getWeather(String cityName) {
// Implementation
}
}
@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 工具。 您可以拥有多个生成 ToolCallbacks 的 Bean,自动配置会将它们合并。
示例应用
-
天气服务器 (WebFlux) - 带有 WebFlux 传输的 Spring AI MCP 服务器 Boot Starter
-
天气服务器 (STDIO) - 带有 STDIO 传输的 Spring AI MCP 服务器 Boot Starter
-
天气服务器手动配置 - Spring AI MCP 服务器 Boot Starter,不使用自动配置,而是使用 Java SDK 手动配置服务器