|
获取最新的快照版本,请使用 Spring AI 1.1.3! |
MCP 服务Starters
Spring AI MCP(模型上下文协议)服务器Starters为 Spring Boot 应用程序中的 MCP 服务器设置提供了自动配置功能。它使 MCP 服务器功能能够与 Spring Boot 的自动配置系统无缝集成。
MCP 服务器Starters提供:
-
MCP 服务器组件的自动配置
-
支持同步和异步的操作模式
-
多个传输层选项
-
灵活的工具、资源与提示说明
-
调整通知能力
Starters
|
There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。 |
根据您的运输需求,选择以下其中一个启动选项:
标准MCP服务器
完整MCP服务器功能支持,且服务器传输为STDIO。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server</artifactId>
</dependency>
-
适合于命令行和桌面工具
-
无需额外的网页依赖项
启动程序会激活负责以下内容的McpServerAutoConfiguration自动配置:
-
配置基本的服务器组件
-
处理工具、资源和提示规范
-
管理服务器能力和变更通知
-
提供同步和异步的服务器实现
WebMVC 服务器传输
完整支持MCP服务器功能,采用基于Spring MVC的SSE(服务器发送事件)服务器传输,并可选使用STDIO传输。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server-webmvc</artifactId>
</dependency>
Starters激活了McpWebMvcServerAutoConfiguration和McpServerAutoConfiguration的自动配置,以提供:
-
基于HTTP的传输,使用Spring MVC(
WebMvcSseServerTransportProvider) -
自动配置的SSE配置文件的端点
-
可选的
STDIO运输(通过设置spring.ai.mcp.server.stdio=true启用) -
包含
spring-boot-starter-web和mcp-spring-webmvc个依赖项
WebFlux 服务器传输
完整支持MCP服务器功能,采用基于Spring WebFlux的SSE(服务器发送事件)服务器传输,并可选使用STDIO传输。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-mcp-server-webflux</artifactId>
</dependency>
Starters激活了McpWebFluxServerAutoConfiguration和McpServerAutoConfiguration的自动配置,以提供:
-
基于Spring WebFlux的响应式传输(
WebFluxSseServerTransportProvider) -
自动配置的响应式SSE端点通过注入% s,可以使用指定的名称来标识该端点。
-
可选的
STDIO运输(通过设置spring.ai.mcp.server.stdio=true启用) -
包含
spring-boot-starter-webflux和mcp-spring-webflux个依赖项
|
由于Spring Boot的默认行为,如果在类路径中同时存在0和1,Spring Boot将优先选择2。因此,如果您的项目使用3,建议使用4而不是5。 |
配置属性
所有属性都以 spring.ai.mcp.server 为前缀:
| 属性 | 描述 | 默认 |
|---|---|---|
|
启用或禁用Maven中心代理 |
|
|
启用/禁用 STDIO 传输 |
|
|
服务器用于识别的名称 |
|
|
服务器版本 |
|
|
可选指令,指导客户如何与该服务器交互。 |
|
|
服务器类型 (同步/异步) |
|
|
启用/禁用资源权限 |
|
|
启用或禁用工具特性 |
|
|
启用/禁用提示功能 |
|
|
启用/禁用完成能力 |
|
|
启用资源变化通知 |
|
|
启用提示更改提醒 |
|
|
启用工具变化的监控/通知 |
|
|
(可选)按工具名称指定响应 MIME 类型。例如, |
|
|
用于客户端发送消息的 Web 传输自定义 SSE 消息端点路径 |
|
|
自定义 Web 传输的 SSE 端点路径 |
|
|
可选的 URL 前缀。例如, |
- |
|
在请求超时之前等待服务器响应的持续时间。适用于通过客户端发出的所有请求,包括工具调用、资源访问和提示操作。 |
|
同步/异步服务器类型
-
同步服务器 - 使用
McpSyncServer实现的默认服务器类型。它用于设计简单的请求-响应模式。要启用此服务器类型,请在您的配置中设置spring.ai.mcp.server.type=SYNC。当启用后,它会自动处理同步工具规范的配置。 -
异步服务器 - 使用异步服务器实现的实现使用了
McpAsyncServer,并经过了非阻塞操作的优化。 要启用此服务器类型,请将您的应用程序配置为spring.ai.mcp.server.type=ASYNC。 此服务器类型会自动设置带有内置Project Reactor支持的异步工具规范。
服务器能力服务器特性
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:
-
标准输入/输出 (STDIO) -
spring-ai-starter-mcp-server -
Spring MVC(服务器发送事件) -
spring-ai-starter-mcp-server-webmvc -
Spring WebFlux (Reactive SSE) -
spring-ai-starter-mcp-server-webflux
功能与特性
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;
}
自动配置将自动检测并注册所有工具回调:
* 单个 ToolCallback bean
* ToolCallback bean 列表
* ToolCallbackProvider bean
工具按名称去重,仅保留每个工具名称的首次出现。
资源管理
提供一种标准化的方式,使服务器能够向客户端公开资源。
-
静态和动态资源规范
-
可选的更改通知
-
支持资源模板
-
同步/异步资源规范之间的自动转换
-
通过 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(
"code-completion",
"Provides code completion suggestions",
(exchange, request) -> {
// Implementation that returns completion suggestions
return new McpSchema.CompletionResult(List.of(
new McpSchema.Completion("suggestion1", "First suggestion"),
new McpSchema.Completion("suggestion2", "Second suggestion")
));
}
);
return List.of(completion);
}
根变更消费者
当根发生变化时,支持listChanged的客户端会发送根变化通知。
-
支持对根变化的监控
-
将响应式应用程序自动转换为异步消费者
-
通过SpringBeans实现可选注册
@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
instructions: "This server provides weather information tools and resources"
sse-message-endpoint: /mcp/messages
capabilities:
tool: true
resource: true
prompt: true
completion: true
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"
sse-message-endpoint: /mcp/messages
capabilities:
tool: true
resource: true
prompt: true
completion: true
使用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 服务器Starters。
-
天气服务器 (STDIO) - 使用 STDIO 传输的 Spring AI MCP 服务器启动程序。
-
天气服务器手动配置 - 不使用自动配置,而是使用Java SDK手动配置服务器的Spring AI MCP服务器Starters。