Lzh on GitHub

STDIO 与 SSE MCP 服务器

STDIO 和 SSE MCP 服务器支持多种传输机制,每种机制都有对应的启动器(starter)。

使用 STDIO 客户端SSE 客户端 连接到 STDIO 和 SSE 服务器。

STDIO MCP 服务器

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

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-mcp-server</artifactId>
</dependency>
  • 适用于命令行和桌面工具
  • 无需额外的 Web 依赖
  • 配置基本的服务器组件
  • 处理工具、资源和提示规格
  • 管理服务器功能及变更通知
  • 支持同步和异步服务器实现

SSE WebMVC 服务器

使用 SSE(Server-Sent Events)服务器传输的完整 MCP 服务器功能支持,基于 Spring MVC,并可选支持 STDIO 传输。

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-mcp-server-webmvc</artifactId>
</dependency>
  • 基于 HTTP 的传输,使用 Spring MVC(WebMvcSseServerTransportProvider
  • 自动配置 SSE 端点
  • 可选 STDIO 传输(通过设置 spring.ai.mcp.server.stdio=true 启用)
  • 包含 spring-boot-starter-webmcp-spring-webmvc 依赖

SSE WebFlux 服务器

使用 SSE(Server-Sent Events)服务器传输的完整 MCP 服务器功能支持,基于 Spring WebFlux,并可选支持 STDIO 传输。

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

该 Starter 激活 McpWebFluxServerAutoConfigurationMcpServerAutoConfiguration 自动配置,提供:

  • 使用 Spring WebFlux 的响应式传输(WebFluxSseServerTransportProvider
  • 自动配置的响应式 SSE 端点
  • 可选 STDIO 传输(通过设置 spring.ai.mcp.server.stdio=true 启用)
  • 包含 spring-boot-starter-webfluxmcp-spring-webflux 依赖
由于 Spring Boot 的默认行为,当类路径中同时存在 org.springframework.web.servlet.DispatcherServletorg.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
tool-callback-converter是否将 Spring AI ToolCallbacks 转换为 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() 工具关联-
request-timeout等待服务器响应的超时时间,适用于客户端发出的所有请求,包括工具调用、资源访问和提示操作20 秒

MCP 注解属性

MCP 服务器注解(MCP Server Annotations)提供了一种使用 Java 注解声明式实现 MCP 服务器处理器的方式。

服务器注解相关属性以 spring.ai.mcp.server.annotation-scanner 为前缀:

属性描述默认值
enabled启用或禁用 MCP 服务器注解的自动扫描true

SSE 属性

所有 SSE 属性均以 spring.ai.mcp.server 为前缀:

属性描述默认值
sse-message-endpoint用于 Web 传输的自定义 SSE 消息端点路径,客户端通过此端点发送消息/mcp/message
sse-endpoint用于 Web 传输的自定义 SSE 端点路径/sse
base-url可选的 URL 前缀。例如,base-url=/api/v1 表示客户端访问 SSE 端点时,完整路径为 /api/v1 + sse-endpoint,消息端点为 /api/v1 + sse-message-endpoint-
keep-alive-interval连接保持活跃的时间间隔null(禁用)
出于向后兼容性考虑,SSE 属性未使用额外的后缀(如 .sse)。

功能与能力

MCP 服务器 Boot Starter 允许服务器向客户端公开工具(tools)、资源(resources)和提示(prompts)。它会根据服务器类型,自动将以 Spring Bean 注册的自定义能力处理器转换为同步(sync)或异步(async)规范。

工具(Tools)

允许服务器公开可供语言模型调用的工具。MCP 服务器 Boot Starter 提供以下功能:

  • 变更通知支持
  • 工具自动转换:根据服务器类型,Spring AI 工具 会自动转换为同步(sync)或异步(async)规范
  • 通过 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;
}

自动注册:Auto-configuration 会自动检测并注册所有工具回调,包括:

  • 单个 ToolCallback Bean
  • ToolCallback Bean 列表
  • ToolCallbackProvider Bean

去重处理:工具按名称去重,每个工具名的第一次出现会被使用。

可禁用自动注册:通过将 tool-callback-converter 设置为 false,可以禁用所有工具回调的自动检测与注册。

工具上下文支持

支持 ToolContext,允许在调用工具时传递上下文信息。ToolContext 包含一个 McpSyncServerExchange 实例,可通过 McpToolUtils.getMcpExchange(toolContext) 访问。示例,可使用 exchange.loggingNotification(...)exchange.createMessage(...)

资源(Resources)

提供一种标准化方式,让服务器向客户端公开资源。

  • 支持静态和动态资源规范
  • 可选的变更通知
  • 支持资源模板
  • 自动转换同步/异步资源规范
@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("生成系统信息失败", e);
            }
        });

    return List.of(resourceSpecification);
}

该示例展示了如何定义一个同步资源规范,并返回 JSON 内容给客户端。

提示(Prompts)

提供一种标准化方式,让服务器向客户端公开 提示模板(Prompt)

  • 支持变更通知
  • 模板版本管理
  • 自动转换同步/异步提示规范
  • 通过 Spring Bean 自动注册提示规范
@Bean
public List<McpServerFeatures.SyncPromptSpecification> myPrompts() {
    var prompt = new McpSchema.Prompt(
        "greeting",
        "一个友好的问候提示",
        List.of(new McpSchema.PromptArgument("name", "要问候的姓名", 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("一个个性化的问候消息", List.of(userMessage));
        }
    );

    return List.of(promptSpecification);
}

该示例展示了如何定义一个同步提示规范,并根据传入的参数生成个性化的问候消息。

补全(Completions)

提供一种标准化方式,让服务器向客户端公开 自动补全(Completion) 功能。

  • 支持同步和异步补全规范
  • 通过 Spring Bean 自动注册
@Bean
public List<McpServerFeatures.SyncCompletionSpecification> myCompletions() {
    var completion = new McpServerFeatures.SyncCompletionSpecification(
        new McpSchema.PromptReference(
            "ref/prompt",
            "code-completion",
            "提供代码补全建议"
        ),
        (exchange, request) -> {
            // 实现逻辑,返回补全建议
            return new McpSchema.CompleteResult(
                List.of("python", "pytorch", "pyside"),
                10,
                true
            );
        }
    );

    return List.of(completion);
}

该示例展示了如何定义一个同步补全规范,并返回一组示例补全建议给客户端。

日志(Logging)

提供一种标准化方式,让服务器向客户端发送 结构化日志消息

工具(Tool)资源(Resource)提示(Prompt)补全(Completion) 的调用处理器中,可使用提供的 McpSyncServerExchangeMcpAsyncServerExchange 对象发送日志消息:

(exchange, request) -> {
    exchange.loggingNotification(
        LoggingMessageNotification.builder()
            .level(LoggingLevel.INFO)
            .logger("test-logger")
            .data("这是一个测试日志消息")
            .build()
    );
}

在 MCP 客户端,可以注册 日志消费者 来处理这些消息:

mcpClientSpec.loggingConsumer((McpSchema.LoggingMessageNotification log) -> {
    // 处理日志消息
});

进度(Progress)

提供一种标准化方式,让服务器向客户端发送 进度更新

工具(Tool)资源(Resource)提示(Prompt)补全(Completion) 的调用处理器中,可使用提供的 McpSyncServerExchangeMcpAsyncServerExchange 对象发送进度通知:

(exchange, request) -> {
    exchange.progressNotification(
        ProgressNotification.builder()
            .progressToken("test-progress-token")
            .progress(0.25)
            .total(1.0)
            .message("工具调用进行中")
            .build()
    );
}

MCP 客户端可以接收进度通知并相应地更新其 UI。为此,需要注册一个进度消费者:

mcpClientSpec.progressConsumer((McpSchema.ProgressNotification progress) -> {
    // 处理进度通知
});

根目录列表变更(Root List Changes)

当根目录(roots)发生变化时,支持 listChanged 的客户端会收到根目录变更通知。

特点包括:

  • 支持监控根目录变化
  • 对响应式(Reactive)应用程序,自动转换为异步消费者
  • 可通过 Spring Bean 可选注册

示例注册方式:

@Bean
public BiConsumer<McpSyncServerExchange, List<McpSchema.Root>> rootsChangeHandler() {
    return (exchange, roots) -> {
        logger.info("注册根资源: {}", roots);
    };
}

Ping

服务器的 Ping 机制用于验证客户端是否仍然存活。在工具、资源、提示或完成调用处理器中,可以使用提供的 McpSyncServerExchange / McpAsyncServerExchange 对象发送 Ping 消息:

(exchange, request) -> {
    exchange.ping();
}

保持连接(Keep Alive)

服务器可以选择性地定期向已连接的客户端发送 Ping,以验证连接状态。

默认情况下,保持活动(keep-alive)功能是关闭的。要启用 keep-alive,请在配置中设置 keep-alive-interval 属性:

spring:
  ai:
    mcp:
      server:
        keep-alive-interval: 30s

使用示例

标准 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 工具。你可以有多个生成 ToolCallback 的 Bean,自动配置会将它们合并处理。

示例应用