跳到主要内容

无题 :: Spring AI 参考

STDIO 与 SSE MCP 服务器​

STDIO 和 SSE MCP 服务器支持多种传输机制，每种机制都有专用的启动器。

提示

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

STDIO MCP 服务器​

完整支持MCP服务器功能，采用STDIO服务器传输协议。

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

  • 适合命令行与桌面工具

  • 无需额外的 Web 依赖

  • 配置基础服务器组件

  • 处理工具、资源和提示规范

  • 管理服务器功能和变更通知

  • 支持同步和异步服务器实现

SSE WebMVC 服务器​

完整的 MCP 服务器功能支持，采用基于 Spring MVC 的 SSE（服务器发送事件）服务器传输，以及一个可选的 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-web 和 mcp-spring-webmvc 依赖项

SSE WebFlux 服务器​

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

<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 和 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 Tool 规格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-endpoint客户端用于发送消息的自定义 SSE 消息端点路径，适用于 Web 传输/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 beans 实现自动资源规范：

@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 Client 可以接收进度通知并相应地更新其用户界面。为此，它需要注册一个进度消费者。

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机制来验证其客户端是否仍处于活动状态。在工具、资源、提示或完成调用处理程序中，使用提供的 McpSyncServerExchange/McpAsyncServerExchange exchange 对象发送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 Server 创建 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，自动配置将合并它们。

示例应用​