|
此版本仍在开发中,尚未被视为稳定版。为了获取最新的快照版本,请使用Spring AI 1.1.3! |
可流式传输的HTTP MCP服务器
The 可流式传输的 HTTP 传输允许 MCP 服务器作为独立进程运行,能够使用 HTTP POST 和 GET 请求处理多个客户端连接,并可选地使用 Server-Sent Events (SSE) 流式传输多个服务器消息。它取代了 SSE 传输。
这些服务器是在规范版本 2025-03-26 中引入的,非常适合需要向客户端通知工具、资源或提示动态变化的应用程序。
设置 spring.ai.mcp.server.protocol=STREAMABLE 属性 |
| 使用 可流式传输的 HTTP 客户端 连接到可流式传输的 HTTP 服务器。 |
可流式传输的HTTP WebMVC服务器
使用spring-ai-starter-mcp-server-webmvc依赖:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server-webmvc</artifactId>
</dependency>
并将spring.ai.mcp.server.protocol属性设置为STREAMABLE。
-
完整的MCP服务器功能,配备Spring MVC可流式传输的传输机制
-
支持工具、资源、提示、补全、日志记录、进度跟踪、ping 以及根目录更改功能
-
持久连接管理
可流式传输的 HTTP WebFlux 服务器
使用spring-ai-starter-mcp-server-webflux依赖:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server-webflux</artifactId>
</dependency>
并将spring.ai.mcp.server.protocol属性设置为STREAMABLE。
-
使用 WebFlux Streamable 传输的响应式 MCP 服务器
-
支持工具、资源、提示、补全、日志记录、进度跟踪、ping 以及根目录更改功能
-
非阻塞、持久连接管理
配置属性
常见属性
所有公共属性都以0前缀
| 属性 | 描述 | 默认 |
|---|---|---|
|
启用/禁用可流式传输的 MCP 服务器 |
|
|
MCP 服务器协议 |
必须设置为 |
|
启用或禁用将Spring AI ToolCallbacks转换为MCP Tool规格的操作 |
|
|
服务器用于识别的名称 |
|
|
服务器版本 |
|
|
可选的客户端交互说明 |
|
|
服务器类型 (同步/异步) |
|
|
启用/禁用资源权限 |
|
|
启用或禁用工具特性 |
|
|
启用/禁用提示功能 |
|
|
启用/禁用完成能力 |
|
|
启用资源变化通知 |
|
|
启用提示更改提醒 |
|
|
启用工具变化的监控/通知 |
|
|
工具名称对应的响应 MIME 类型 |
|
|
请求超时持续时间 |
|
功能与特性
MCP 服务器支持四种主要的能力类型,这些类型可以单独启用或禁用:
-
工具 - 使用
spring.ai.mcp.server.capabilities.tool=true|false启用/禁用工具功能 -
资源 - 使用
spring.ai.mcp.server.capabilities.resource=true|false启用/禁用资源功能 -
提示 - 使用
spring.ai.mcp.server.capabilities.prompt=true|false启用/禁用提示功能 -
补全 - 使用
spring.ai.mcp.server.capabilities.completion=true|false启用/禁用补全功能
所有功能都是默认启用的。关闭某个功能将阻止服务器注册并暴露相应功能给客户端。
MCP 服务器Starters允许服务器向客户端公开工具、资源和提示。 它会根据服务器类型,自动将注册为 Spring Bean 的自定义能力处理器转换为同步/异步规范:
工具
允许服务器公开可由语言模型调用的工具。MCP 服务器Starters提供:
-
更改通知支持
-
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 -
ToolCallback个 Bean 的列表 -
ToolCallbackProvider个 bean
工具按名称去重,仅保留每个工具名称的首次出现。
您可以将tool-callback-converter设置为false,以禁用所有工具回调的自动检测和注册。 |
资源
提供一种标准化的方式,使服务器能够向客户端公开资源。
-
静态和动态资源规范
-
可选的更改通知
-
支持资源模板
-
同步/异步资源规范之间的自动转换
-
通过 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 ObjectMapper().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客户端上,你可以注册 logging消费者来处理这些消息:
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的客户端会发送根变化通知。
-
支持对根变化的监控
-
将响应式应用程序自动转换为异步消费者
-
通过SpringBeans实现可选注册
@Bean
public BiConsumer<McpSyncServerExchange, List<McpSchema.Root>> rootsChangeHandler() {
return (exchange, roots) -> {
logger.info("Registering root resources: {}", roots);
};
}
击打
ping机制,用于服务器验证其客户端是否仍然存活。在工具或框架中,当处理资源、提示或完成调用时,会使用提供的McpSyncServerExchange、McpAsyncServerExchange、exchange对象来发送ping消息:
(exchange, request) -> {
exchange.ping();
}
保持连接
服务器可以(可选地)定期向已连接的客户端发送 ping 请求,以验证连接健康状况。
默认情况下,keep-alive 是禁用的。
要启用 keep-alive,请在配置中设置 keep-alive-interval 属性:
spring:
ai:
mcp:
server:
streamable-http:
keep-alive-interval: 30s
| 目前,对于 streamable-http 服务器,keep-alive 机制仅适用于从服务器接收消息(SSE)连接。 |
使用示例
可流式传输的HTTP服务器配置
# Using spring-ai-starter-mcp-server-streamable-webmvc
spring:
ai:
mcp:
server:
protocol: STREAMABLE
name: streamable-mcp-server
version: 1.0.0
type: SYNC
instructions: "This streamable server provides real-time notifications"
resource-change-notification: true
tool-change-notification: true
prompt-change-notification: true
streamable-http:
mcp-endpoint: /api/mcp
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,自动配置会将它们合并。