MCP Server Starter

本站(springdoc.cn)中的内容来源于 spring.io ，原始版权归属于 spring.io。由 springdoc.cn 进行翻译，整理。可供个人学习、研究，未经许可，不得进行任何转载、商用或与之相关的行为。 商标声明：Spring 是 Pivotal Software, Inc. 在美国以及其他国家的商标。

Spring AI MCP（模型上下文协议）Server Starter 为在 Spring Boot 应用中设置 MCP 服务器提供了自动配置。它使得 MCP 服务器功能能够与 Spring Boot 的自动配置系统实现无缝集成。

MCP Server Starter 提供以下功能：

  • MCP 服务器组件的自动配置

  • 支持同步和异步操作模式

  • 多种传输层选项

  • 灵活的工具、资源和提示规范

  • 变更通知功能

Starter

Spring AI 自动配置和 Starter 模块的工件名称发生了重大变化。请参阅 升级说明 以获取更多信息。

根据你的传输需求选择以下 Starter 之一：

标准 MCP Server

通过 STDIO 服务器传输，支持完整的 MCP 服务器功能。

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

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

  • 无需额外的 Web 依赖

Starter 激活 McpServerAutoConfiguration 自动配置，负责：

  • 配置基本服务器组件

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

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

  • 提供同步和异步服务器实现

WebMVC Server Transport

完整的 MCP 服务器功能支持基于 Spring MVC 的 SSE（服务器发送事件）服务器传输和可选的 STDIO 传输。

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

该 Starter 会激活 McpWebMvcServerAutoConfiguration 和 McpServerAutoConfiguration 自动配置，以提供以下功能：

  • 基于 HTTP 的传输（使用 Spring MVC）（WebMvcSseServerTransportProvider）

  • 自动配置的 SSE 端点

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

  • 包含 spring-boot-starter-web 和 mcp-spring-webmvc 依赖项

WebFlux Server Transport

基于 Spring WebFlux 并可选 STDIO 传输，提供对完整 MCP 服务器功能的支持（使用 SSE 服务器传输）。

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

该 Starter 会激活 McpWebFluxServerAutoConfiguration 和 McpServerAutoConfiguration 自动配置，以提供以下功能：

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

  • 自动配置的响应式 SSE 端点

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

  • 包含 spring-boot-starter-webflux 和 mcp-spring-webflux 依赖项

配置属性

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

属性 说明 默认值

enabled

启用/禁用 MCP 服务器

true

stdio

启用/禁用 stdio 传输

false

name

用于标识的服务器名称

mcp-server

version

服务器版本

1.0.0

instructions

可选的说明，用于指导客户端如何与此服务器交互

null

type

服务器类型（同步/异步）

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 类型。例如，spring.ai.mcp.server.tool-response-mime-type.generateImage=image/png 会将 image/png MIME 类型与 generateImage() 工具名称关联起来。

-

sse-message-endpoint

客户端用于发送消息的自定义 SSE 消息端点路径（用于 Web 传输）

/mcp/message

sse-endpoint

用于 Web 传输的自定义 SSE 端点路径

/sse

base-url

可选的 URL 前缀。例如，base-url=/api/v1 表示客户端应在 /api/v1 + sse-endpoint 处访问 sse 端点，而消息端点为 /api/v1 + sse-message-endpoint

-

request-timeout

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

20 seconds

Sync/Async 服务器类型

  • 同步服务器 - 默认的服务器类型，通过 McpSyncServer 实现。它适用于应用程序中的简单请求-响应模式。要启用此服务器类型，请在配置中设置 spring.ai.mcp.server.type=SYNC。激活后，它将自动处理同步工具规范的配置。

  • 异步服务器 - 异步服务器实现使用 McpAsyncServer，专为非阻塞操作而优化。要启用此服务器类型，请在应用程序中配置 spring.ai.mcp.server.type=ASYNC。该服务器类型会自动设置带有内置 Project Reactor 支持的异步工具规范。

服务器功能

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 服务器支持三种传输机制，每种均有专用 Starter：

  • Standard Input/Output （STDIO） - spring-ai-starter-mcp-server

  • Spring MVC （Server-Sent Events） - spring-ai-starter-mcp-server-webmvc

  • Spring WebFlux（Reactive SSE） - spring-ai-starter-mcp-server-webflux

功能与特性

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

工具

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

  • 变更通知支持

  • 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

工具按名称去重，每个工具名称仅保留首次出现的实例。

ToolContext 支持

支持 ToolContext，允许向工具调用传递上下文信息。该上下文包含一个通过 exchange Key 访问的 McpSyncServerExchange 实例（可通过 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(
        "code-completion",
        "Provides code completion suggestions",
        (exchange, request) -> {
            // Implementation that returns completion suggestions
            return new McpSchema.CompletionResult(List.of(
                new McpSchema.Completion("suggestion1", "First suggestion"),
                new McpSchema.Completion("suggestion2", "Second suggestion")
            ));
        }
    );

    return List.of(completion);
}

Root 变更监听

当 Root 变更时，支持 listChanged 的客户端会发送 Root Change 通知。

  • Root 变更监控支持

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

  • 通过 Spring Bean 可选注册

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

使用示例

标准 STDIO 服务器配置

# Using spring-ai-starter-mcp-server
spring:
  ai:
    mcp:
      server:
        name: stdio-mcp-server
        version: 1.0.0
        type: SYNC

WebMVC Server 配置

# 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"
        sse-message-endpoint: /mcp/messages
        capabilities:
          tool: true
          resource: true
          prompt: true
          completion: true

WebFlux Server 配置

# 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"
        sse-message-endpoint: /mcp/messages
        capabilities:
          tool: true
          resource: true
          prompt: true
          completion: true

使用 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 生成 ToolCallback，自动配置将合并这些实例。

示例应用

额外资源