跳到主要内容

Untitled :: Spring AI 参考文档

可流式传输的 HTTP MCP 服务器​

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

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

提示

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

:::提示
使用可流式 HTTP 客户端连接到可流式 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。

  • 完整的 MCP 服务器功能，支持 Spring MVC Streamable 传输协议

  • 支持工具、资源、提示、补全、日志记录、进度追踪、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 Streamable传输的Reactive MCP服务器

  • 支持工具、资源、提示、补全、日志记录、进度跟踪、ping、根目录变更等能力

  • 非阻塞、持久连接管理

配置属性​

通用属性​

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

属性描述默认值
enabled启用/禁用可流式传输的 MCP 服务器true
protocolMCP 服务器协议必须设置为 STREAMABLE 以启用可流式传输的服务器
tool-callback-converter启用/禁用将 Spring AI ToolCallbacks 转换为 MCP 工具规范的功能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
tool-response-mime-type按工具名称设置的响应 MIME 类型-
request-timeout请求超时时长20 秒

MCP 注解属性​

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

服务器 MCP 注解属性的前缀为 spring.ai.mcp.server.annotation-scanner：

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

Streamable-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 beans 自动生成工具规范：

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

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:
        streamable-http:
          keep-alive-interval: 30s
备注

目前，对于流式HTTP服务器，keep-alive机制仅适用于监听服务器消息（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工具。您可以拥有多个产生ToolCallback的Bean，自动配置会将其合并。