9.2 MCP Server Boot Starter

吴祖贤
61 阅读8分钟

MCP Server Boot Starter

Spring AI MCP（模型上下文协议）服务器Boot启动器为在Spring Boot应用程序中设置MCP服务器提供自动配置。它实现了MCP服务器功能与Spring Boot自动配置系统的无缝集成。

MCP服务器Boot启动器提供：

  • MCP服务器组件的自动配置
  • 支持同步和异步操作模式
  • 多种传输层选项
  • 灵活的工具、资源和提示规范
  • 变更通知功能

Starters

Spring AI自动配置和启动器模块的工件名称发生了重大变更。请参阅升级说明获取更多信息。

根据您的传输需求选择以下启动器之一：

标准MCP服务器

使用STDIO服务器传输支持完整的MCP服务器功能。

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-mcp-server</artifactId>
</dependency>

适用于命令行和桌面工具 无需额外的Web依赖

该启动器激活McpServerAutoConfiguration自动配置，负责：

  • 配置基本服务器组件
  • 处理工具、资源和提示规范
  • 管理服务器功能和变更通知
  • 提供同步和异步服务器实现

WebMVC服务器传输

使用基于Spring MVC的SSE（服务器发送事件）服务器传输支持完整的MCP服务器功能，并提供可选的STDIO传输。

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-mcp-server-webmvc</artifactId>
</dependency>

该启动器激活McpWebMvcServerAutoConfiguration和McpServerAutoConfiguration自动配置以提供：

  • 使用Spring MVC的基于HTTP的传输（WebMvcSseServerTransportProvider）
  • 自动配置的SSE端点
  • 可选的STDIO传输（通过设置spring.ai.mcp.server.stdio=true启用）
  • 包含的spring-boot-starter-web和mcp-spring-webmvc依赖

WebFlux服务器传输

使用基于Spring WebFlux的SSE（服务器发送事件）服务器传输支持完整的MCP服务器功能，并提供可选的STDIO传输。

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-mcp-server-webflux</artifactId>
</dependency>

该启动器激活McpWebFluxServerAutoConfiguration和McpServerAutoConfiguration自动配置以提供：

  • 使用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同时存在于类路径上时，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/ASYNC）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类型。例如spring.ai.mcp.server.tool-response-mime-type.generateImage=image/png将image/png mime类型与generateImage()工具名称关联-
sse-message-endpoint客户端用于发送消息的Web传输自定义SSE消息端点路径/mcp/message
sse-endpointWeb传输的自定义SSE端点路径/sse
base-url可选URL前缀。例如base-url=/api/v1表示客户端应该在/api/v1 + sse-endpoint访问sse端点，消息端点是/api/v1 + sse-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服务器Boot启动器允许服务器向客户端公开工具、资源和提示。它会根据服务器类型自动注册为Spring bean的自定义功能处理器转换为同步/异步规范：

工具

允许服务器公开可供语言模型调用的工具。MCP服务器Boot启动器提供：

  • 变更通知支持
  • 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

工具按名称去重，每个工具名称的第一次出现将被使用。

工具上下文支持

支持ToolContext，允许将上下文信息传递给工具调用。它在exchange键下包含一个McpSyncServerExchange实例，可通过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(
        "code-completion",
        "Provides code completion suggestions",
        (exchange, request) -> {
            // 返回补全建议的实现
            return new McpSchema.CompletionResult(List.of(
                new McpSchema.Completion("suggestion1", "First suggestion"),
                new McpSchema.Completion("suggestion2", "Second suggestion")
            ));
        }
    );

    return List.of(completion);
}

根变更消费者

当根目录变更时，支持listChanged的客户端会发送根变更通知。

  • 支持监控根变更
  • 自动转换为响应式应用程序的异步消费者
  • 通过Spring bean的可选注册
@Bean
public BiConsumer<McpSyncServerExchange, List<McpSchema.Root>> rootsChangeHandler() {
    return (exchange, roots) -> {
        logger.info("Registering root resources: {}", roots);
    };
}

使用示例

标准STDIO服务器配置

# 使用spring-ai-starter-mcp-server
spring:
  ai:
    mcp:
      server:
        name: stdio-mcp-server
        version: 1.0.0
        type: SYNC

WebMVC服务器配置

# 使用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服务器配置

# 使用spring-ai-starter-mcp-server-webflux
spring:
  ai:
    mcp:
      server:
        name: webflux-mcp-server
        version: 1.0.0
        type: ASYNC  # 响应式应用程序推荐
        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。自动配置会合并它们。

示例应用程序

其他资源

avatar
文章
阅读
粉丝