Spring AI 参考文档

模型上下文协议（MCP）

MCP 服务器启动启动器

可流式 HTTP MCP 服务器

可流式 HTTP 传输允许 MCP 服务器作为独立进程运行，能够使用 HTTP POST 和 GET 请求处理多个客户端连接，并可选择使用服务器发送事件（SSE）流式传输多个服务器消息。它取代了 SSE 传输。

这些服务器随规范版本 2025-03-26 引入，非常适合需要向客户端通知工具、资源或提示动态变更的应用程序。

• 设置 spring.ai.mcp.server.protocol=STREAMABLE 属性。
• 使用可流式 HTTP 客户端连接到可流式 HTTP 服务器。

可流式 HTTP WebMVC 服务器

使用 spring-ai-starter-mcp-server-webmvc 依赖项：

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

并将 spring.ai.mcp.server.protocol 属性设置为 STREAMABLE。

• 基于 Spring MVC 可流式传输的完整 MCP 服务器功能
• 支持工具、资源、提示、补全、日志记录、进度、Ping、根变更能力
• 持久连接管理

可流式 HTTP WebFlux 服务器

使用 spring-ai-starter-mcp-server-webflux 依赖项：

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

并将 spring.ai.mcp.server.protocol 属性设置为 STREAMABLE。

• 基于 WebFlux 可流式传输的响应式 MCP 服务器
• 支持工具、资源、提示、补全、日志记录、进度、Ping、根变更能力
• 非阻塞、持久连接管理

配置属性

通用属性

所有通用属性均以 spring.ai.mcp.server 为前缀：

属性	描述	默认值
enabled	启用/禁用可流式 MCP 服务器	true
protocol	MCP 服务器协议。必须设置为 STREAMABLE 以启用可流式服务器	-
tool-callback-converter	启用/禁用将 Spring AI ToolCallback 转换为 MCP Tool 规范	true
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
expose-mcp-client-tools	是否将下游 MCP 工具（由 MCP 客户端提供）重新暴露为此 MCP 服务器中的工具	false
tool-response-mime-type	按工具名称指定的响应 MIME 类型	-
request-timeout	请求超时时长	20 秒

MCP 注解属性

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

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

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

可流式 HTTP 属性

所有可流式 HTTP 属性以 spring.ai.mcp.server.streamable-http 为前缀：

属性	描述	默认值
mcp-endpoint	自定义 MCP 端点路径	/mcp
keep-alive-interval	连接保活间隔	null（禁用）
disallow-delete	禁用删除操作	false

特性和能力

MCP 服务器支持四种主要能力类型，可以单独启用或禁用：

• 工具 - 使用 spring.ai.mcp.server.capabilities.tool=true|false 启用/禁用工具能力
• 资源 - 使用 spring.ai.mcp.server.capabilities.resource=true|false 启用/禁用资源能力
• 提示 - 使用 spring.ai.mcp.server.capabilities.prompt=true|false 启用/禁用提示能力
• 补全 - 使用 spring.ai.mcp.server.capabilities.completion=true|false 启用/禁用补全能力

所有能力默认启用。禁用某项能力将阻止服务器向客户端注册和暴露相应的功能。

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，允许将上下文信息传递给工具调用。它包含一个 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 JsonMapper().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, TextContent.builder("Hello " + nameArgument + "! How can I assist you today?").build());
        return GetPromptResult.builder(List.of(userMessage)).description("A personalized greeting message").build();
    });

    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(LoggingLevel.INFO, "This is a test log message")
            .logger("test-logger")
            .build());
}

在 MCP 客户端上，您可以注册日志消费者来处理这些消息：

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

进度

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

(exchange, request) -> {
        exchange.progressNotification(ProgressNotification.builder("test-progress-token", 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:
        streamable-http:
          keep-alive-interval: 30s

目前，对于可流式 HTTP 服务器，保活机制仅适用于 Listening for Messages from the Server（SSE）连接。

使用示例

可流式 HTTP 服务器配置

# 使用 spring-ai-starter-mcp-server-streamable-webmvc
spring:
  ai:
    mcp:
      server:
        protocol: STREAMABLE
        name: streamable-mcp-server
        version: 1.0.0
        type: SYNC
        instructions: "该可流式服务器提供实时通知"
        resource-change-notification: true
        tool-change-notification: true
        prompt-change-notification: true
        streamable-http:
          mcp-endpoint: /api/mcp
          keep-alive-interval: 30s

创建带有 MCP 服务器的 Spring Boot 应用

@Service
public class WeatherService {

    @Tool(description = "按城市名称获取天气信息")
    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，自动配置会将它们合并。