Skip to content
Spring AI 文档版本 2.1.0-SNAPSHOT 源快照 8bfb128c 更新于 2026-10-16

STDIO 与 SSE MCP 服务端

STDIO 与 SSE MCP 服务端支持多种传输机制,每种都有其专属的 starter。

TIP

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

STDIO MCP 服务端

带 STDIO 服务端传输的完整 MCP 服务端功能支持。

xml
<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-mcp-server</artifactId>
</dependency>
  • 适合命令行与桌面工具
  • 无需额外的 web 依赖
  • 基本服务端组件的配置
  • 工具、资源和提示词规格的处理
  • 服务端能力与变更通知的管理
  • 对同步与异步两种服务端实现的支持

SSE WebMVC 服务端

带基于 Spring MVC 的 SSE(服务器发送事件)服务端传输、以及一个可选 STDIO 传输的完整 MCP 服务端功能支持。

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

SSE WebFlux 服务端

带基于 Spring WebFlux 的 SSE(服务器发送事件)服务端传输、以及一个可选 STDIO 传输的完整 MCP 服务端功能支持。

xml
<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 和 org.springframework.ai:mcp-spring-webflux 依赖

NOTE

由于 Spring Boot 的默认行为,当 classpath 上同时存在 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
tool-callback-converter
启用/禁用把 Spring AI ToolCallbacks 转换为 MCP Tool 声明
true
stdio
启用/禁用 STDIO 传输
false
name
用于标识的服务端名称
mcp-server
version
服务端版本
1.0.0
instructions
可选说明,指导客户端如何与本服务端交互
null
type
服务端类型(SYNC/ASYNC)
SYNC
capabilities.resource
启用/禁用 resource 能力
true
capabilities.tool
启用/禁用 tool 能力
true
capabilities.prompt
启用/禁用 prompt 能力
true
capabilities.completion
启用/禁用 completion 能力
true
resource-change-notification
启用资源变更通知
true
prompt-change-notification
启用 prompt 变更通知
true
tool-change-notification
启用 tool 变更通知
true
expose-mcp-client-tools
是否把下游 MCP 工具(由 MCP 客户端提供)在本 MCP 服务端中重新暴露为工具
false
tool-response-mime-type
按工具名指定的可选响应 MIME 类型。例如 spring.ai.mcp.server.tool-response-mime-type.generateImage=image/png 会把 image/png 这一 MIME 类型与 generateImage() 工具名关联起来
-
request-timeout
等待服务端响应的超时时长。对经客户端发出的所有请求生效,包括工具调用、资源访问与 prompt 操作
20 seconds

MCP 注解属性

MCP 服务端注解提供了一种用 Java 注解实现 MCP 服务端处理器的声明式方式。

服务端 mcp-annotations 属性以 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 前缀。 For example, base-url=/api/v1 means 即客户端应在 /api/v1 + sse-endpoint 访问 SSE 端点,消息端点则是 /api/v1 + sse-message-endpoint
-
keep-alive-interval
连接保活间隔
null (disabled)

NOTE

出于向后兼容的考虑,SSE 属性不带额外的后缀(如 .sse)。

特性与能力

MCP 服务端 Boot Starter 让服务端能向客户端暴露工具、资源和提示词。 它会自动把作为 Spring bean 注册的自定义能力处理器,依据服务端类型转换为同步/异步规格:

工具

让服务端能暴露可被语言模型调用的工具。MCP 服务端 Boot Starter 提供:

  • 变更通知支持
  • Spring AI 工具 会依据服务端类型自动转换为同步/异步规格
  • 通过 Spring bean 自动进行工具规格声明:
java
@Bean
public ToolCallbackProvider myTools(...) {
    List<ToolCallback> tools = ...
    return ToolCallbackProvider.from(tools);
}

或使用底层 API:

java
@Bean
public List<McpServerFeatures.SyncToolSpecification> myTools(...) {
    List<McpServerFeatures.SyncToolSpecification> tools = ...
    return tools;
}

自动配置会自动检测并注册来自以下各处的所有工具回调:

  • 单个 ToolCallback bean
  • ToolCallback bean 的列表
  • ToolCallbackProvider bean

工具会按名去重,使用每个工具名的首次出现。

TIP

你可以通过把 tool-callback-converter 设为 false 来禁用对所有工具回调的自动检测与注册。

工具上下文支持

支持 ToolContext,允许把上下文信息传给工具调用。它在 exchange 键下包含一个 McpSyncServerExchange 实例,可通过 McpToolUtils.getMcpExchange(toolContext) 访问。参见这个演示 exchange.loggingNotification(...) 和 exchange.createMessage(...) 的示例。

资源

为服务端向客户端暴露资源提供标准化方式。

  • 静态与动态资源规格
  • 可选的变更通知
  • 对资源模板的支持
  • 同步/异步资源规格间的自动转换
  • 通过 Spring bean 自动进行资源规格声明:
java
@Bean
public List<McpServerFeatures.SyncResourceSpecification> myResources(...) {
    var systemInfoResource = McpSchema.Resource.builder(...);
    var resourceSpecification = new McpServerFeatures.SyncResourceSpecification(systemInfoResource, (exchange, request) -> {
        try {
            var systemInfo = Map.of(...);
            String jsonContent = new JsonMapper().writeValueAsString(systemInfo);
            return McpSchema.ReadResourceResult.builder(
                    List.of(McpSchema.TextResourceContents.builder(request.uri(), jsonContent).mimeType("application/json").build()));
        }
        catch (Exception e) {
            throw new RuntimeException("Failed to generate system info", e);
        }
    });

    return List.of(resourceSpecification);
}

提示词

为服务端向客户端暴露提示词模板提供标准化方式。

  • 变更通知支持
  • 模板版本化
  • 同步/异步提示词规格间的自动转换
  • 通过 Spring bean 自动进行提示词规格声明:
java
@Bean
public List<McpServerFeatures.SyncPromptSpecification> myPrompts() {
    var prompt = McpSchema.Prompt.builder("greeting").description("A friendly greeting prompt")
        .arguments(List.of(McpSchema.PromptArgument.builder("name").description("The name to greet").required(true).build())).build();

    var promptSpecification = new McpServerFeatures.SyncPromptSpecification(prompt, (exchange, getPromptRequest) -> {
        String nameArgument = (String) getPromptRequest.arguments().get("name");
        if (nameArgument == null) { nameArgument = "friend"; }
        var userMessage = PromptMessage.builder(Role.USER, TextContent.builder("Hello " + nameArgument + "! How can I assist you today?").build()).build();
        return GetPromptResult.builder(List.of(userMessage)).description("A personalized greeting message").build();
    });

    return List.of(promptSpecification);
}

补全

为服务端向客户端暴露补全能力提供标准化方式。

  • 对同步与异步补全规格两者的支持
  • 通过 Spring bean 自动注册:
java
@Bean
public List<McpServerFeatures.SyncCompletionSpecification> myCompletions() {
    var completion = new McpServerFeatures.SyncCompletionSpecification(
        McpSchema.PromptReference.builder("code-completion").title("Provides code completion suggestions").build(),
        (exchange, request) -> {
            // Implementation that returns completion suggestions
            return new McpSchema.CompleteResult(List.of("python", "pytorch", "pyside"), 10, true);
        }
    );

    return List.of(completion);
}

日志

为服务端向客户端发送结构化日志消息提供标准化方式。 在工具、资源、提示词或补全调用处理器内部,使用所提供的 McpSyncServerExchange/McpAsyncServerExchange exchange 对象发送日志消息:

java
(exchange, request) -> {
        exchange.loggingNotification(LoggingMessageNotification.builder(LoggingLevel.INFO, "This is a test log message")
            .logger("test-logger")
            .build());
}

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

java
mcpClientSpec.loggingConsumer((McpSchema.LoggingMessageNotification log) -> {
    // Handle log messages
});

进度

为服务端向客户端发送进度更新提供标准化方式。 在工具、资源、提示词或补全调用处理器内部,使用所提供的 McpSyncServerExchange/McpAsyncServerExchange exchange 对象发送进度通知:

java
(exchange, request) -> {
        exchange.progressNotification(ProgressNotification.builder("test-progress-token", 0.25)
            .total(1.0)
            .message("tool call in progress")
            .build());
}

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

java
mcpClientSpec.progressConsumer((McpSchema.ProgressNotification progress) -> {
    // Handle progress notifications
});

Root 列表变更

当 roots 变化时,支持 listChanged 的客户端会发送一个 root 变更通知。

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

Ping

供服务端验证其客户端仍然存活的 Ping 机制。 在工具、资源、提示词或补全调用处理器内部,使用所提供的 McpSyncServerExchange/McpAsyncServerExchange exchange 对象发送 ping 消息:

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

Keep Alive

服务端可以选择性地定期向已连接客户端发出 ping 以验证连接健康。

默认情况下 keep-alive 是禁用的。 要启用 keep-alive,在你的配置中设置 keep-alive-interval 属性:

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

用法示例

标准 STDIO 服务端配置

yaml
# Using spring-ai-starter-mcp-server
spring:
  ai:
    mcp:
      server:
        name: stdio-mcp-server
        version: 1.0.0
        type: SYNC

WebMVC 服务端配置

yaml
# 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 服务端配置

yaml
# 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 应用

java
@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,自动配置会把它们合并。

示例应用

BytesRouter 是社区翻译站点,所有译文仅供参考,一切以官方英文原文为准。