Untitled :: Spring AI 参考

Streamable-HTTP MCP 服务器

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

这些服务器在规范版本 2025-03-26 中引入，适用于需要向客户端通知 tools、resources 或 prompts 动态变化的应用场景。

提示

设置 spring.ai.mcp.server.protocol=STREAMABLE 属性

提示

使用 Streamable-HTTP 客户端 连接到 Streamable-HTTP 服务器。

Streamable-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 Streamable 传输能力的完整 MCP 服务器功能

• 支持 tools、resources、prompts、completion、logging、progression、ping、root-changes 等能力

• 持久化连接管理

Streamable-HTTP WebFlux Server

使用 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 Streamable 传输的响应式 MCP 服务器

• 支持 tools、resources、prompts、completion、logging、progression、ping、root-changes 功能

• 非阻塞、持久化连接管理

配置属性

通用属性

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

属性	描述	默认值
enabled	启用/禁用流式 MCP 服务器	true
protocol	MCP 服务器协议	必须设置为 STREAMABLE 以启用流式服务器
tool-callback-converter	启用/禁用将 Spring AI ToolCallbacks 转换为 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 seconds

MCP Annotations 属性 {#_mcp_annotations_properties}

QWen 3.8 中英对照 Streamable-HTTP MCP Servers MCP Annotations Properties

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

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

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

Streamable-HTTP 属性

所有 streamable-HTTP 属性均带有 spring.ai.mcp.server.streamable-http 前缀：

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

功能与能力

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

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

所有功能默认均处于启用状态。禁用某项功能将阻止服务器向客户端注册并公开相应的特性。

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

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

• 支持变更通知

• Spring AI 工具 会根据服务器类型自动转换为同步/异步规范

• 通过 Spring 自动装配实现自动工具规范：

@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 = 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())).build();
        }
        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 = McpSchema.Prompt.builder("greeting").description("A friendly greeting prompt")
        .arguments(List.of(McpSchema.PromptArgument.builder("name").title("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);
}

提供一种标准化方式，使服务器能够向客户端暴露补全能力。

• 同时支持同步和异步的完成（completion）规范
• 通过 Spring bean 进行自动注册：

@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 对象发送日志消息：

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

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

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

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

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

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

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

当根节点发生更改时，支持 listChanged 的客户端会发送根节点更改通知。

• 支持监控根更改（root changes）

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

• 通过 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:
        streamable-http:
          keep-alive-interval: 30s

备注

目前，对于 streamable-http 服务器，keep-alive 机制仅在 Listening for Messages from the Server (SSE) 连接中可用。

使用示例

Streamable HTTP 服务器配置

# Using spring-ai-starter-mcp-server-streamable-webmvc
spring:
  ai:
    mcp:
      server:
        protocol: STREAMABLE
        name: streamable-mcp-server
        version: 1.0.0
        type: SYNC
        instructions: "This streamable server provides real-time notifications"
        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 = "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，自动配置会将它们进行合并。