MCP 服务器 Boot Starter
Spring AI MCP(模型上下文协议)服务器 Boot Starter 为在 Spring Boot 应用程序中设置 MCP 服务器提供自动配置。它实现了 MCP 服务器功能与 Spring Boot 自动配置系统的无缝集成。
MCP 服务器 Boot Starter 提供
-
MCP 服务器组件的自动配置
-
支持同步和异步操作模式
-
多种传输层选项
-
灵活的工具、资源和 Prompt 规范
-
更改通知功能
Starters
Spring AI 自动配置、starter 模块的 artifact 名称发生了重大变化。请参阅升级说明以获取更多信息。 |
根据您的传输要求选择以下 starter 之一
标准 MCP 服务器
支持完整的 MCP 服务器功能,并使用 STDIO
服务器传输。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server</artifactId>
</dependency>
-
适用于命令行和桌面工具
-
无需额外的 Web 依赖项
该 starter 激活负责以下功能的 McpServerAutoConfiguration
自动配置:
-
配置基本服务器组件
-
处理工具、资源和 Prompt 规范
-
管理服务器功能和更改通知
-
提供同步和异步服务器实现
WebMVC 服务器传输
支持完整的 MCP 服务器功能,并使用基于 Spring MVC 的 SSE
(Server-Sent Events)服务器传输和可选的 STDIO
传输。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server-webmvc</artifactId>
</dependency>
该 starter 激活 McpWebMvcServerAutoConfiguration
和 McpServerAutoConfiguration
自动配置以提供
-
使用 Spring MVC 的基于 HTTP 的传输 (
WebMvcSseServerTransportProvider
) -
自动配置的 SSE 端点
-
可选的
STDIO
传输(通过设置spring.ai.mcp.server.stdio=true
启用) -
包含
spring-boot-starter-web
和mcp-spring-webmvc
依赖项
WebFlux 服务器传输
支持完整的 MCP 服务器功能,并使用基于 Spring WebFlux 的 SSE
(Server-Sent Events)服务器传输和可选的 STDIO
传输。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server-webflux</artifactId>
</dependency>
该 starter 激活 McpWebFluxServerAutoConfiguration
和 McpServerAutoConfiguration
自动配置以提供
-
使用 Spring WebFlux 的响应式传输 (
WebFluxSseServerTransportProvider
) -
自动配置的响应式 SSE 端点
-
可选的
STDIO
传输(通过设置spring.ai.mcp.server.stdio=true
启用) -
包含
spring-boot-starter-webflux
和mcp-spring-webflux
依赖项
配置属性
所有属性都带有前缀 spring.ai.mcp.server
属性 | 描述 | 默认值 |
---|---|---|
|
启用/禁用 MCP 服务器 |
|
|
启用/禁用 stdio 传输 |
|
|
用于标识的服务器名称 |
|
|
服务器版本 |
|
|
服务器类型 (SYNC/ASYNC) |
|
|
启用资源更改通知 |
|
|
启用 Prompt 更改通知 |
|
|
启用工具更改通知 |
|
|
(可选)每个工具名称的响应 MIME 类型。例如 |
|
|
Web 传输自定义 SSE 消息端点路径,供客户端发送消息使用 |
|
|
Web 传输自定义 SSE 端点路径 |
|
|
可选的 URL 前缀。例如 |
- |
同步/异步服务器类型
-
同步服务器 - 使用
McpSyncServer
实现的默认服务器类型。它专为应用程序中的简单请求-响应模式而设计。要启用此服务器类型,请在配置中设置spring.ai.mcp.server.type=SYNC
。激活后,它会自动处理同步工具规范的配置。 -
异步服务器 - 异步服务器实现使用
McpAsyncServer
,并针对非阻塞操作进行了优化。要启用此服务器类型,请使用spring.ai.mcp.server.type=ASYNC
配置您的应用程序。此服务器类型会自动设置具有内置 Project Reactor 支持的异步工具规范。
传输选项
MCP 服务器支持三种传输机制,每种机制都有自己的专用 starter
-
标准输入/输出 (STDIO) -
spring-ai-starter-mcp-server
-
Spring MVC (Server-Sent Events) -
spring-ai-starter-mcp-server-webmvc
-
Spring WebFlux (响应式 SSE) -
spring-ai-starter-mcp-server-webflux
功能和能力
MCP 服务器 Boot Starter 允许服务器向客户端公开工具、资源和 Prompt。它会根据服务器类型自动将注册为 Spring bean 的自定义能力处理程序转换为同步/异步规范。
工具
允许服务器公开可由语言模型调用的工具。MCP 服务器 Boot Starter 提供:
-
更改通知支持
-
工具会根据服务器类型自动转换为同步/异步规范
-
通过 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;
}
资源管理
提供一种标准化方式供服务器向客户端公开资源。
-
静态和动态资源规范
-
可选的更改通知
-
支持资源模板
-
同步/异步资源规范之间的自动转换
-
通过 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);
}
Prompt 管理
提供一种标准化方式供服务器向客户端公开 Prompt 模板。
-
更改通知支持
-
模板版本控制
-
同步/异步 Prompt 规范之间的自动转换
-
通过 Spring bean 自动进行 Prompt 规范
@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);
}
Root 更改消费者
当根(roots)发生变化时,支持 listChanged
的客户端会发送 Root 更改通知。
-
支持监控根更改
-
自动转换为响应式应用程序的异步消费者
-
通过 Spring bean 进行可选注册
@Bean
public BiConsumer<McpSyncServerExchange, List<McpSchema.Root>> rootsChangeHandler() {
return (exchange, roots) -> {
logger.info("Registering root resources: {}", roots);
};
}
使用示例
标准 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
sse-message-endpoint: /mcp/messages
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
sse-message-endpoint: /mcp/messages
创建带有 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。
-
天气服务器手动配置 - 不使用自动配置,而是使用 Java SDK 手动配置服务器的 Spring AI MCP 服务器 Boot Starter。