MCP 服务器启动器
Spring AI MCP(模型上下文协议)服务器启动启动器提供了在 Spring Boot 应用程序中设置 MCP 服务器的自动配置功能。它支持 MCP 服务器功能与 Spring Boot 的自动配置系统无缝集成。
MCP 服务器启动器提供:
MCP 服务器组件的自动配置
支持同步和异步操作模式
多种传输层选项
灵活的工具、资源和提示规范
更改通知功能
开胃菜
Spring AI 自动配置和启动模块的构件名称发生了重大变化。请参阅升级说明了解更多信息。
根据您的运输需求选择以下其中一种启动器:
标准 MCP 服务器
完整的 MCP 服务器功能支持STDIO服务器传输。
无需额外的 Web 依赖项
启动器激活McpServerAutoConfiguration自动配置,负责:
配置基本服务器组件
处理工具、资源和提示规范
管理服务器功能和变更通知
提供同步和异步服务器实现
WebMVC 服务器传输
完整的 MCP 服务器功能支持SSE基于 Spring MVC 的(服务器发送事件)服务器传输和可选STDIO传输。
使用 Spring MVC 的基于 HTTP 的传输(WebMvcSseServerTransportProvider)
自动配置的 SSE 端点
可选STDIO传输(通过设置启用spring.ai.mcp.server.stdio=true)
包含spring-boot-starter-web和mcp-spring-webmvc依赖项
WebFlux 服务器传输
完整的 MCP 服务器功能支持SSE基于 Spring WebFlux 和可选传输的(服务器发送事件)服务器传输STDIO。
使用 Spring WebFlux 进行反应式传输(WebFluxSseServerTransportProvider)
自动配置的反应式 SSE 端点
可选STDIO传输(通过设置启用spring.ai.mcp.server.stdio=true)
包含spring-boot-starter-webflux和mcp-spring-webflux依赖项
由于 Spring Boot 的默认行为,当 和 同时org.springframework.web.servlet.DispatcherServlet存在org.springframework.web.reactive.DispatcherHandler于 Classpath 中时,Spring Boot 将优先考虑DispatcherServlet。因此,如果您的项目使用spring-boot-starter-web,建议使用spring-ai-starter-mcp-server-webmvc而不是spring-ai-starter-mcp-server-webflux。
配置属性
所有属性都以 为前缀spring.ai.mcp.server:
财产 描述 默认
enabled
启用/禁用 MCP 服务器
true
stdio
启用/禁用 stdio 传输
false
name
用于识别的服务器名称
mcp-server
version
服务器版本
1.0.0
instructions
可选指令,用于指导客户端如何与该服务器交互
null
type
服务器类型(同步/异步)
SYNC
capabilities.resource
启用/禁用资源功能
true
capabilities.tool
启用/禁用工具功能
true
capabilities.prompt
启用/禁用提示功能
true
capabilities.completion
启用/禁用完成功能
true
resource-change-notification
启用资源更改通知
true
prompt-change-notification
启用提示更改通知
true
tool-change-notification
启用工具更改通知
true
tool-response-mime-type
(可选)每个工具名称的响应 MIME 类型。例如,将MIME 类型与工具名称spring.ai.mcp.server.tool-response-mime-type.generateImage=image/png关联image/pnggenerateImage()
-
sse-message-endpoint
客户端用来发送消息的 Web 传输的自定义 SSE 消息端点路径
/mcp/message
sse-endpoint
用于 Web 传输的自定义 SSE 端点路径
/sse
base-url
可选 URL 前缀。例如,表示客户端应访问位于+ 的base-url=/api/v1SSE 端点,而消息端点位于+/api/v1sse-endpoint/api/v1sse-message-endpoint
-
request-timeout
请求超时前等待服务器响应的时长。适用于所有通过客户端发出的请求,包括工具调用、资源访问和提示操作。
20秒
同步/异步服务器类型
同步服务器- 使用 实现的默认服务器类型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 服务器支持三种传输机制,每种机制都有其专用的启动器:
标准输入/输出 (STDIO) -spring-ai-starter-mcp-server
Spring MVC(服务器发送事件) -spring-ai-starter-mcp-server-webmvc
Spring WebFlux(反应式 SSE)spring-ai-starter-mcp-server-webflux
特性和功能
MCP 服务器启动器允许服务器向客户端公开工具、资源和提示。它会自动将注册为 Spring Bean 的自定义功能处理程序根据服务器类型转换为同步/异步规范:
工具
允许服务器公开可通过语言模型调用的工具。MCP 服务器启动启动器提供:
变更通知支持
Spring AI Tools根据服务器类型自动转换为同步/异步规范
通过 Spring beans 自动指定工具:
@Bean
public ToolCallbackProvider myTools(…) {
List
return ToolCallbackProvider.from(tools);
}
或者使用低级 API:
@Bean
public List<McpServerFeatures.SyncToolSpecification> myTools(…) {
List<McpServerFeatures.SyncToolSpecification> tools = …
return tools;
}
自动配置将自动检测并注册来自以下位置的所有工具回调:* 单个ToolCallbackbean * bean 列表ToolCallback* ToolCallbackProviderbean
工具按名称进行重复数据删除,并使用每个工具名称的第一次出现。
工具上下文支持
支持ToolContext ,允许将上下文信息传递给工具调用。它包含一个键下的实例,可通过 访问。请参阅此示例,其中演示了和。McpSyncServerExchangeexchangeMcpToolUtils.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 beans 自动提示规范:
@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 beans 自动注册:
@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会发送根更改通知。
支持监控根更改
自动转换为异步消费者以用于反应式应用程序
通过 Spring beans 进行可选注册
@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 Server 创建 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。自动配置会将它们合并。
最后编辑:Jeebiz 更新时间:2025-08-08 00:47