STDIO 和 SSE MCP 服务器

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-webmcp-spring-webmvc 依赖项

SSE WebFlux 服务器

通过基于 Spring WebFlux 的 SSE(服务器发送事件)服务器传输和可选的 STDIO 传输提供完整的 MCP 服务器功能支持。

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

该启动器激活 McpWebFluxServerAutoConfigurationMcpServerAutoConfiguration 自动配置以提供

  • 使用 Spring WebFlux 的反应式传输 (WebFluxSseServerTransportProvider)

  • 自动配置的反应式 SSE 端点

  • 可选的 STDIO 传输(通过设置 spring.ai.mcp.server.stdio=true 启用)

  • 包含 spring-boot-starter-webfluxmcp-spring-webflux 依赖项

由于 Spring Boot 的默认行为,当 classpath 中同时存在 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 传输

name

用于识别的服务器名称

mcp-server

version

服务器版本

1.0.0

instructions

可选说明,为客户端提供如何与此服务器交互的指导

null

类型

服务器类型(同步/异步)

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-endpoint

用于 Web 传输的自定义 SSE 消息端点路径,供客户端发送消息

/mcp/message

sse-endpoint

用于 Web 传输的自定义 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 Server Boot Starter允许服务器向客户端公开工具、资源和提示。它会自动将注册为Spring bean的自定义能力处理程序根据服务器类型转换为同步/异步规范

工具

允许服务器公开可由语言模型调用的工具。MCP Server Boot Starter提供

  • 变更通知支持

  • 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,允许将上下文信息传递给工具调用。它包含一个 McpSyncServerExchange 实例,位于 exchange 键下,可通过 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) -> {
            // Implementation that returns completion suggestions
            return new McpSchema.CompleteResult(List.of("python", "pytorch", "pyside"), 10, true);
        }
    );

    return List.of(completion);
}

日志

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

(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) -> {
    // Handle log messages
});

进度

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

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

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

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

根列表变更

当根发生变化时,支持 listChanged 的客户端会发送根变化通知。

  • 支持监控根变化

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

  • 通过 Spring bean 可选注册

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

Ping

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

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

保活

服务器可以选择定期向连接的客户端发送 ping,以验证连接健康状况。

默认情况下,保活已禁用。要启用保活,请在配置中设置 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工具。您可以有多个生成ToolCallbacks的bean,自动配置将合并它们。

示例应用程序

© . This site is unofficial and not affiliated with VMware.