Untitled :: Spring AI 参考

STDIO 和 SSE MCP 服务器

STDIO 和 SSE MCP Servers 支持多种传输机制，每种机制都有专属的 starter。

提示

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

STDIO MCP 服务器

完整支持 MCP Server 功能，并使用 STDIO 服务器传输方式。

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

• 适用于命令行和桌面工具

• 无需额外的 Web 依赖项

• 基本服务器组件的配置

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

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

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

SSE WebMVC 服务器

完全支持 MCP Server 功能，基于 Spring MVC 的 SSE（Server-Sent Events）服务器传输方式，并可选支持 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 和 org.springframework.ai:mcp-spring-webmvc 依赖

SSE WebFlux Server

全面支持 MCP Server 功能，基于 Spring WebFlux 实现 SSE（Server-Sent Events）服务器传输，并可选 STDIO 传输方式。

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

启动器会激活 McpWebFluxServerAutoConfiguration 和 McpServerAutoConfiguration 自动配置，以提供：

• 使用 Spring WebFlux 进行响应式传输（WebFluxSseServerTransportProvider）

• 自动配置响应式 SSE 端点

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

• 包含 spring-boot-starter-webflux 和 org.springframework.ai: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
expose-mcp-client-tools	是否将下游 MCP 工具（由 MCP 客户端提供）重新作为本 MCP 服务器中的工具暴露	false
tool-response-mime-type	可选的按工具名称指定的响应 MIME 类型。例如，spring.ai.mcp.server.tool-response-mime-type.generateImage=image/png 会将 image/png MIME 类型与 generateImage() 工具名称关联	-
request-timeout	在请求超时前等待服务器响应的时长。适用于通过客户端发出的所有请求，包括工具调用、资源访问和提示词操作	20 seconds

MCP 注释属性

MCP Server Annotations 提供了一种使用 Java 注解实现 MCP server handlers 的声明式方式。

服务器 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 允许服务器向客户端暴露工具（tools）、资源（resources）和提示词（prompts）。它会根据服务器类型，将注册为 Spring Bean 的自定义能力处理器自动转换为同步/异步规范：

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

• 变更通知支持

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

• 通过 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 组件

• ToolCallback 组件列表

• ToolCallbackProvider 组件

工具按名称去重，每个工具名称首次出现的实例将被采用。

提示

您可以通过将 tool-callback-converter 设置为 false 来禁用所有工具回调的自动检测和注册。

工具上下文支持

ToolContext 是受支持的，允许在工具调用中传递上下文信息。它包含 exchange 键下的 McpSyncServerExchange 实例，可通过 McpToolUtils.getMcpExchange(toolContext) 访问。请参考此示例，其中演示了 exchange.loggingNotification(…​) 和 exchange.createMessage(…​) 的用法。

为服务器向客户端公开资源提供了一种标准化的方式。

• 静态和动态资源规格

• 可选的变更通知

• 支持资源模板

• 同步/异步资源规格的自动转换

• 通过 Spring beans 自动设置资源规格

@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()));
        }
        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").description("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);
}

为服务器向客户端暴露补全功能提供了一种标准化的方式。

• 支持同步和异步完成规格

• 通过 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 客户端中，您可以注册 logging consumers 来处理这些消息：

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
});

当 roots 发生变化时，支持 listChanged 的客户端会发送 root 变更通知。

• 支持监控根变化

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

• 通过 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();
	}
}

auto-configuration 会自动将工具回调注册为 MCP 工具。你可以拥有多个生成 ToolCallbacks 的 bean，auto-configuration 会将它们合并。

示例应用

• 天气服务器 (WebFlux) - 使用 WebFlux 传输的 Spring AI MCP Server Boot Starter

• 天气服务器 (STDIO) - 使用 STDIO 传输的 Spring AI MCP Server Boot Starter

• 天气服务器手动配置 - 不使用自动配置，而是通过 Java SDK 手动配置服务器的 Spring AI MCP Server Boot Starter