可流式传输的 HTTP MCP 服务器
可流式传输的 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。
-
使用 Spring MVC 可流式传输传输的完整 MCP 服务器功能
-
支持工具、资源、提示、完成、日志记录、进度、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 可流式传输传输的响应式 MCP 服务器
-
支持工具、资源、提示、完成、日志记录、进度、ping、根更改功能
-
非阻塞、持久连接管理
配置属性
通用属性
所有公共属性都以 spring.ai.mcp.server 为前缀
| 财产 | 描述 | 默认值 |
|---|---|---|
|
启用/禁用可流式传输的 MCP 服务器 |
|
|
MCP 服务器协议 |
必须设置为 |
|
启用/禁用Spring AI ToolCallbacks到MCP工具规范的转换 |
|
|
用于识别的服务器名称 |
|
|
服务器版本 |
|
|
客户端交互的可选指令 |
|
|
服务器类型(同步/异步) |
|
|
启用/禁用资源能力 |
|
|
启用/禁用工具能力 |
|
|
启用/禁用提示能力 |
|
|
启用/禁用完成能力 |
|
|
启用资源更改通知 |
|
|
启用提示更改通知 |
|
|
启用工具更改通知 |
|
|
每个工具名称的响应 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 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;
}
自动配置将自动检测并注册所有来自以下来源的工具回调:
-
单个
ToolCallbackbean -
ToolCallbackbean列表 -
ToolCallbackProviderbean
工具按名称去重,使用每个工具名称的第一次出现。
通过将 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 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 客户端上,您可以注册日志消费者来处理这些消息。
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 客户端可以接收进度通知并相应地更新其 UI。为此,它需要注册一个进度消费者。
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
用于服务器验证其客户端是否仍然活跃的 Ping 机制。在工具、资源、提示或完成调用处理程序中,使用提供的 McpSyncServerExchange/McpAsyncServerExchange exchange 对象发送 ping 消息。
(exchange, request) -> {
exchange.ping();
}
保持连接
服务器可以选择性地定期向连接的客户端发送 ping 以验证连接健康状况。
默认情况下,保持连接是禁用的。要启用保持连接,请在您的配置中设置 keep-alive-interval 属性。
spring:
ai:
mcp:
server:
streamable-http:
keep-alive-interval: 30s
| 目前,对于可流式传输的 HTTP 服务器,保持连接机制仅适用于侦听来自服务器的消息 (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,自动配置将合并它们。