Untitled :: Spring AI 参考文档
无状态可流式HTTP MCP服务器
无状态可流式HTTP MCP服务器专为简化部署场景设计,在请求之间不维护会话状态。这类服务器非常适合微服务架构和云原生部署环境。
设置 spring.ai.mcp.server.protocol=STATELESS 属性
:::提示
使用 可流式 HTTP 客户端 连接无状态服务器。
:::
无状态服务器不支持向 MCP 客户端发送消息请求(例如,询问、采样、ping)。
无状态 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 属性设置为 STATELESS。
spring.ai.mcp.server.protocol=STATELESS
-
基于Spring MVC传输的无状态操作
-
无会话状态管理
-
简化的部署模型
-
针对云原生环境优化
无状态 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 属性设置为 STATELESS。
-
采用 WebFlux 传输实现响应式无状态操作
-
无需管理会话状态
-
支持非阻塞式请求处理
-
针对高吞吐量场景进行优化
配置属性
通用属性
所有通用属性都以 spring.ai.mcp.server 为前缀:
| 属性 | 描述 | 默认值 |
|---|---|---|
enabled | 启用/禁用无状态 MCP 服务器 | true |
protocol | MCP 服务器协议 | 必须设置为 STATELESS 以启用无状态服务器 |
tool-callback-converter | 启用/禁用将 Spring AI ToolCallbacks 转换为 MCP Tool 规范 | true |
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 |
tool-response-mime-type | 按工具名称的响应 MIME 类型 | - |
request-timeout | 请求超时时长 | 20 seconds |
MCP 注解属性
MCP Server Annotations 提供了一种使用 Java 注解以声明式方式实现 MCP 服务器处理器的方法。
服务器 mcp-annotations 属性以 spring.ai.mcp.server.annotation-scanner 作为前缀:
| 属性 | 描述 | 默认值 |
|---|---|---|
enabled | 启用/禁用 MCP 服务器注解的自动扫描功能 | true |
无状态连接属性
所有连接属性的前缀为 spring.ai.mcp.server.stateless:
| 属性 | 描述 | 默认值 |
|---|---|---|
mcp-endpoint | 自定义 MCP 端点路径 | /mcp |
disallow-delete | 禁止删除操作 | 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<McpStatelessServerFeatures.SyncToolSpecification> myTools(...) {
List<McpStatelessServerFeatures.SyncToolSpecification> tools = ...
return tools;
}
自动配置将自动检测并注册所有来自以下来源的工具回调:
-
单独的
ToolCallbackBean -
ToolCallbackBean 列表 -
ToolCallbackProviderBean
工具将按名称进行去重处理,以每个工具名称首次出现为准。
:::提示
你可以通过将 tool-callback-converter 设置为 false 来禁用所有工具回调的自动检测与注册。
:::
工具上下文支持不适用于无状态服务器。
为服务器提供了一种标准化的方式向客户端暴露资源。
-
静态与动态资源规范
-
可选变更通知
-
支持资源模板
-
同步/异步资源规范间的自动转换
-
通过 Spring Bean 实现自动资源规范:
@Bean
public List<McpStatelessServerFeatures.SyncResourceSpecification> myResources(...) {
var systemInfoResource = new McpSchema.Resource(...);
var resourceSpecification = new McpStatelessServerFeatures.SyncResourceSpecification(systemInfoResource, (context, 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 beans自动配置提示规范:
@Bean
public List<McpStatelessServerFeatures.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 McpStatelessServerFeatures.SyncPromptSpecification(prompt, (context, 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<McpStatelessServerFeatures.SyncCompletionSpecification> myCompletions() {
var completion = new McpStatelessServerFeatures.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);
}
使用示例
无状态服务器配置
spring:
ai:
mcp:
server:
protocol: STATELESS
name: stateless-mcp-server
version: 1.0.0
type: ASYNC
instructions: "This stateless server is optimized for cloud deployments"
streamable-http:
mcp-endpoint: /api/mcp
创建带有 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工具。你可以有多个生成ToolCallback的bean,自动配置会合并它们。