此版本仍在开发中,尚不被认为是稳定的。对于最新的快照版本,请使用 Spring AI 1.0.1! |
STDIO 和 SSE MCP 服务器
STDIO 和 SSE MCP 服务器支持多种传输机制,每种机制都有其专用的Starters。
STDIO MCP 服务器
完整的 MCP 服务器功能支持STDIO
服务器传输。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server</artifactId>
</dependency>
-
适用于命令行和桌面工具
-
无需额外的 Web 依赖项
-
基本服务器组件的配置
-
工具、资源和提示规格的处理
-
管理服务器功能和更改通知
-
支持同步和异步服务器实现
SSE WebMVC 服务器
完整的 MCP 服务器功能支持SSE
(Server-Sent Events)基于 Spring MVC 的服务器传输和可选的STDIO
运输。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server-webmvc</artifactId>
</dependency>
-
使用 Spring MVC (
WebMvcSseServerTransportProvider
) -
自动配置的 SSE 端点
-
自选
STDIO
传输(通过设置spring.ai.mcp.server.stdio=true
) -
包括
spring-boot-starter-web
和mcp-spring-webmvc
依赖
SSE WebFlux 服务器
完整的 MCP 服务器功能支持SSE
(Server-Sent Events)基于 Spring WebFlux 的服务器传输和可选的STDIO
运输。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server-webflux</artifactId>
</dependency>
Starters激活McpWebFluxServerAutoConfiguration
和McpServerAutoConfiguration
auto 配置以提供:
-
使用 Spring WebFlux (
WebFluxSseServerTransportProvider
) -
自动配置的响应式 SSE 端点
-
自选
STDIO
传输(通过设置spring.ai.mcp.server.stdio=true
) -
包括
spring-boot-starter-webflux
和mcp-spring-webflux
依赖
由于 Spring Boot 的默认行为,当 |
配置属性
共同属性
所有 Common 属性都以spring.ai.mcp.server
:
属性 | 描述 | 默认值 |
---|---|---|
|
启用/禁用 MCP 服务器 |
|
|
启用/禁用将 Spring AI ToolCallbacks 转换为 MCP 工具规范 |
|
|
启用/禁用 STDIO 传输 |
|
|
用于标识的服务器名称 |
|
|
服务器版本 |
|
|
可选说明,用于向客户端提供有关如何与此服务器交互的指导 |
|
|
服务器类型 (SYNC/ASYNC) |
|
|
启用/禁用资源功能 |
|
|
启用/禁用工具功能 |
|
|
启用/禁用提示功能 |
|
|
启用/禁用完成功能 |
|
|
启用资源更改通知 |
|
|
启用提示更改通知 |
|
|
启用刀具更换通知 |
|
|
每个工具名称的可选响应 MIME 类型。 例如 |
|
|
在超时请求之前等待服务器响应的持续时间。适用于通过客户端发出的所有请求,包括工具调用、资源访问和提示作 |
|
上交所属性
所有 SSE 属性都以spring.ai.mcp.server
:
属性 | 描述 | 默认值 |
---|---|---|
|
客户端用于发送消息的 Web 传输的自定义 SSE 消息终结点路径 |
|
|
用于 Web 传输的自定义 SSE 终结点路径 |
|
|
可选的 URL 前缀。 例如 |
|
|
连接保持活动间隔 |
|
出于向后兼容性的原因,SSE 属性没有额外的后缀(例如.sse ). |
特性和功能
MCP Server Boot Starter 允许服务器向客户端公开工具、资源和提示。它根据服务器类型自动将注册为 Spring Bean 的自定义功能处理程序转换为同步/异步规范:
工具
允许服务器公开可由语言模型调用的工具。MCP Server Boot Starter 提供:
-
更改通知支持
-
Spring AI Tools 会根据服务器类型自动转换为同步/异步规范
-
通过 Spring beans 自动指定工具:
@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
豆 -
列表
ToolCallback
豆 -
ToolCallbackProvider
豆
工具按名称进行重复数据删除,并使用每个工具名称的第一次出现。
您可以通过设置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 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);
}
Logging
为服务器提供向客户端发送结构化日志消息的标准化方法。
在工具、资源、提示或完成调用处理程序中使用提供的McpSyncServerExchange
/McpAsyncServerExchange
exchange
object 发送日志消息:
(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 机制,用于验证其客户端是否仍处于活动状态。
在工具、资源、提示或完成调用处理程序中使用提供的McpSyncServerExchange
/McpAsyncServerExchange
exchange
object 发送 ping 消息:
(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 工具。您可以让多个 bean 生成 ToolCallbacks,自动配置将合并它们。
示例应用
-
天气服务器 (WebFlux) - 带有 WebFlux 传输的 Spring AI MCP 服务器启动Starters
-
天气服务器 (STDIO) - 具有 STDIO 传输功能的 Spring AI MCP 服务器Starters
-
Weather Server 手动配置 - Spring AI MCP Server Boot Starter,不使用自动配置,而是使用 Java SDK 手动配置服务器