此版本仍在开发中,尚不被认为是稳定的。对于最新的快照版本,请使用 Spring AI 1.0.1spring-doc.cadn.net.cn

STDIO 和 SSE MCP 服务器

STDIO 和 SSE MCP 服务器支持多种传输机制,每种机制都有其专用的Starters。spring-doc.cadn.net.cn

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

STDIO MCP 服务器

完整的 MCP 服务器功能支持STDIO服务器传输。spring-doc.cadn.net.cn

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

SSE WebMVC 服务器

完整的 MCP 服务器功能支持SSE(Server-Sent Events)基于 Spring MVC 的服务器传输和可选的STDIO运输。spring-doc.cadn.net.cn

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

SSE WebFlux 服务器

完整的 MCP 服务器功能支持SSE(Server-Sent Events)基于 Spring WebFlux 的服务器传输和可选的STDIO运输。spring-doc.cadn.net.cn

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

Starters激活McpWebFluxServerAutoConfigurationMcpServerAutoConfigurationauto 配置以提供:spring-doc.cadn.net.cn

由于 Spring Boot 的默认行为,当org.springframework.web.servlet.DispatcherServletorg.springframework.web.reactive.DispatcherHandler存在于类路径上,Spring Boot 将优先考虑DispatcherServlet.因此,如果您的项目使用spring-boot-starter-web,建议使用spring-ai-starter-mcp-server-webmvc而不是spring-ai-starter-mcp-server-webflux.spring-doc.cadn.net.cn

配置属性

共同属性

所有 Common 属性都以spring.ai.mcp.server:spring-doc.cadn.net.cn

属性 描述 默认值

enabledspring-doc.cadn.net.cn

启用/禁用 MCP 服务器spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

tool-callback-converterspring-doc.cadn.net.cn

启用/禁用将 Spring AI ToolCallbacks 转换为 MCP 工具规范spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

stdiospring-doc.cadn.net.cn

启用/禁用 STDIO 传输spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

namespring-doc.cadn.net.cn

用于标识的服务器名称spring-doc.cadn.net.cn

mcp-serverspring-doc.cadn.net.cn

versionspring-doc.cadn.net.cn

服务器版本spring-doc.cadn.net.cn

1.0.0spring-doc.cadn.net.cn

instructionsspring-doc.cadn.net.cn

可选说明,用于向客户端提供有关如何与此服务器交互的指导spring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

typespring-doc.cadn.net.cn

服务器类型 (SYNC/ASYNC)spring-doc.cadn.net.cn

SYNCspring-doc.cadn.net.cn

capabilities.resourcespring-doc.cadn.net.cn

启用/禁用资源功能spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

capabilities.toolspring-doc.cadn.net.cn

启用/禁用工具功能spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

capabilities.promptspring-doc.cadn.net.cn

启用/禁用提示功能spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

capabilities.completionspring-doc.cadn.net.cn

启用/禁用完成功能spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

resource-change-notificationspring-doc.cadn.net.cn

启用资源更改通知spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

prompt-change-notificationspring-doc.cadn.net.cn

启用提示更改通知spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

tool-change-notificationspring-doc.cadn.net.cn

启用刀具更换通知spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

tool-response-mime-typespring-doc.cadn.net.cn

每个工具名称的可选响应 MIME 类型。 例如spring.ai.mcp.server.tool-response-mime-type.generateImage=image/png将关联image/pngMIME 类型与generateImage()工具名称spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

request-timeoutspring-doc.cadn.net.cn

在超时请求之前等待服务器响应的持续时间。适用于通过客户端发出的所有请求,包括工具调用、资源访问和提示作spring-doc.cadn.net.cn

20 secondsspring-doc.cadn.net.cn

上交所属性

所有 SSE 属性都以spring.ai.mcp.server:spring-doc.cadn.net.cn

属性 描述 默认值

sse-message-endpointspring-doc.cadn.net.cn

客户端用于发送消息的 Web 传输的自定义 SSE 消息终结点路径spring-doc.cadn.net.cn

/mcp/messagespring-doc.cadn.net.cn

sse-endpointspring-doc.cadn.net.cn

用于 Web 传输的自定义 SSE 终结点路径spring-doc.cadn.net.cn

/ssespring-doc.cadn.net.cn

base-urlspring-doc.cadn.net.cn

可选的 URL 前缀。 例如base-url=/api/v1表示客户端应访问位于/api/v1 + sse-endpoint消息端点为/api/v1 + sse-message-endpointspring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

keep-alive-intervalspring-doc.cadn.net.cn

连接保持活动间隔spring-doc.cadn.net.cn

null(禁用)spring-doc.cadn.net.cn

出于向后兼容性的原因,SSE 属性没有额外的后缀(例如.sse).

特性和功能

MCP Server Boot Starter 允许服务器向客户端公开工具、资源和提示。它根据服务器类型自动将注册为 Spring Bean 的自定义功能处理程序转换为同步/异步规范:spring-doc.cadn.net.cn

工具

允许服务器公开可由语言模型调用的工具。MCP Server Boot Starter 提供:spring-doc.cadn.net.cn

@Bean
public ToolCallbackProvider myTools(...) {
    List<ToolCallback> tools = ...
    return ToolCallbackProvider.from(tools);
}

或使用低级 API:spring-doc.cadn.net.cn

@Bean
public List<McpServerFeatures.SyncToolSpecification> myTools(...) {
    List<McpServerFeatures.SyncToolSpecification> tools = ...
    return tools;
}

自动配置将自动检测并注册来自以下位置的所有工具回调:spring-doc.cadn.net.cn

工具按名称进行重复数据删除,并使用每个工具名称的第一次出现。spring-doc.cadn.net.cn

您可以通过设置tool-callback-converterfalse.

工具上下文支持

支持 ToolContext,允许将上下文信息传递给工具调用。它包含一个McpSyncServerExchange实例下的exchange密钥,可通过以下方式访问McpToolUtils.getMcpExchange(toolContext). 请参阅此示例演示exchange.loggingNotification(…​)exchange.createMessage(…​).spring-doc.cadn.net.cn

资源

为服务器向客户端公开资源提供标准化方法。spring-doc.cadn.net.cn

@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-doc.cadn.net.cn

@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-doc.cadn.net.cn

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

Logging

为服务器提供向客户端发送结构化日志消息的标准化方法。 在工具、资源、提示或完成调用处理程序中使用提供的McpSyncServerExchange/McpAsyncServerExchange exchangeobject 发送日志消息:spring-doc.cadn.net.cn

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

在 MCP 客户端上,您可以注册日志记录使用者来处理以下消息:spring-doc.cadn.net.cn

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

进展

为服务器提供向客户端发送进度更新的标准化方法。 在工具、资源、提示或完成调用处理程序中使用提供的McpSyncServerExchange/McpAsyncServerExchange exchange对象发送进度通知:spring-doc.cadn.net.cn

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

Mcp 客户端可以接收进度通知并相应地更新其 UI。 为此,它需要注册一个进度使用者。spring-doc.cadn.net.cn

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

根列表更改

当根发生变化时,支持listChanged发送根更改通知。spring-doc.cadn.net.cn

@Bean
public BiConsumer<McpSyncServerExchange, List<McpSchema.Root>> rootsChangeHandler() {
    return (exchange, roots) -> {
        logger.info("Registering root resources: {}", roots);
    };
}

Ping 机制,用于验证其客户端是否仍处于活动状态。 在工具、资源、提示或完成调用处理程序中使用提供的McpSyncServerExchange/McpAsyncServerExchange exchangeobject 发送 ping 消息:spring-doc.cadn.net.cn

(exchange, request) -> {
        exchange.ping();
}

保持活力

服务器可以选择定期向连接的客户端发出 ping 以验证连接运行状况。spring-doc.cadn.net.cn

默认情况下,keep-alive 处于禁用状态。 要启用 keep-alive,请将keep-alive-interval配置中的属性:spring-doc.cadn.net.cn

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 服务器创建 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 工具。您可以让多个 bean 生成 ToolCallbacks,自动配置将合并它们。spring-doc.cadn.net.cn

示例应用