收藏本站,收获最前沿的人工智能与编程资讯!!

Spring AI STDIO 和 SSE 类型的 MCP 服务器

技术文档 13℃ 0

STDIO 和 SSE 类型的 MCP 服务器支持多种传输机制,每种传输机制都对应专用的启动器。

可使用 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 服务器

基于 Spring MVC 实现 SSE(服务器发送事件)服务器传输协议,并可选支持 STDIO 传输协议,提供完整的 MCP 服务器功能。

<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 和 mcp-spring-webmvc 依赖

SSE WebFlux 服务器

基于 Spring WebFlux 实现 SSE(服务器发送事件)服务器传输协议,并可选支持 STDIO 传输协议,提供完整的 MCP 服务器功能。

<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
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 服务器注解提供了一种声明式方式,可通过 Java 注解实现 MCP 服务器处理器。

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

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

SSE 属性

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

属性描述默认值
sse-message-endpointWeb 传输的自定义 SSE 消息端点路径,供客户端发送消息使用/mcp/message
sse-endpointWeb 传输的自定义 SSE 端点路径/sse
base-url可选 URL 前缀。例如:base-url=/api/v1 表示客户端需访问 /api/v1 + sse-endpoint 作为 SSE 端点,/api/v1 + sse-message-endpoint 作为消息端点-
keep-alive-interval连接保活间隔null(禁用)

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

功能与能力

MCP 服务器启动器允许服务器向客户端暴露工具、资源和提示词。它会根据服务器类型,自动将注册为 Spring Bean 的自定义能力处理器转换为同步/异步规范:

工具

允许服务器暴露可被大语言模型调用的工具。MCP 服务器启动器提供:

  • 变更通知支持

  • 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

工具会按名称去重,仅保留每个工具名称首次出现的实例。

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

工具上下文支持

支持工具上下文(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(
        new McpSchema.PromptReference(
					"ref/prompt", "code-completion", "Provides code completion suggestions"),
        (exchange, request) -> {
            // 实现返回补全建议的逻辑
            return new McpSchema.CompleteResult(List.of("python", "pytorch", "pyside"), 10, true);
        }
    );

    return List.of(completion);
}

日志

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

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

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

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

进度

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

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

MCP 客户端可接收进度通知并相应更新界面,需注册进度消费者:

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

根目录列表变更

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

  • 支持监控根目录变更

  • 为响应式应用自动转换为异步消费者

  • 可通过 Spring Bean 可选注册:

@Bean
public BiConsumer<McpSyncServerExchange, List<McpSchema.Root>> rootsChangeHandler() {
    return (exchange, roots) -> {
        logger.info("Registering root resources: {}", roots);
    };
}

Ping 检测

服务器用于验证客户端是否在线的 Ping 机制。在工具、资源、提示词或补全调用处理器内部,可使用提供的 McpSyncServerExchange/McpAsyncServerExchange 交换对象发送 Ping 消息:

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

连接保活

服务器可定期向已连接的客户端发送 Ping 请求,验证连接健康状态(可选)。

默认禁用连接保活。如需启用,在配置中设置 keep-alive-interval 属性:

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

使用示例

标准 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"
        capabilities:
          tool: true
          resource: true
          prompt: true
          completion: true
        # sse 属性
        sse-message-endpoint: /mcp/messages
        keep-alive-interval: 30s

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"
        capabilities:
          tool: true
          resource: true
          prompt: true
          completion: true
        # sse 属性
        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) {
        // 业务实现
    }
}

@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 服务器启动器

  • 天气服务器(STDIO)- 基于 STDIO 传输的 Spring AI MCP 服务器启动器

  • 天气服务器手动配置 - 不使用自动配置、通过 Java SDK 手动配置服务器的 Spring AI MCP 服务器启动器

相关推荐