此版本仍在开发中,尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT!spring-doc.cadn.net.cn

MCP 服务器启动Starters

Spring AI MCP(模型上下文协议)服务器Starters提供了在 Spring Boot 应用程序中设置 MCP 服务器的自动配置。它支持将 MCP 服务器功能与 Spring Boot 的自动配置系统无缝集成。spring-doc.cadn.net.cn

MCP Server Boot Starter 提供:spring-doc.cadn.net.cn

首先

根据您的运输要求选择以下Starters之一:spring-doc.cadn.net.cn

标准 MCP 服务器

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

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

Starters会激活McpServerAutoConfigurationauto-configuration 负责:spring-doc.cadn.net.cn

WebMVC 服务器传输

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

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

Starters会激活McpWebMvcServerAutoConfigurationMcpServerAutoConfigurationauto-configurations 提供:spring-doc.cadn.net.cn

WebFlux 服务器传输

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

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

Starters会激活McpWebFluxServerAutoConfigurationMcpServerAutoConfigurationauto-configurations 提供:spring-doc.cadn.net.cn

配置属性

所有属性都以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

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

typespring-doc.cadn.net.cn

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

SYNCspring-doc.cadn.net.cn

resource-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

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

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

truespring-doc.cadn.net.cn

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

Web 传输的 SSE 终端节点路径spring-doc.cadn.net.cn

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

Sync/Async 服务器类型

  • 同步服务器 - 使用McpSyncServer. 它专为应用程序中的简单请求-响应模式而设计。 要启用此服务器类型,请将spring.ai.mcp.server.type=SYNC在您的配置中。 激活后,它会自动处理同步工具注册的配置。spring-doc.cadn.net.cn

  • 异步服务器 - 异步服务器实现使用McpAsyncServer并针对非阻塞作进行了优化。 要启用此服务器类型,请使用spring.ai.mcp.server.type=ASYNC. 此服务器类型使用内置的 Project Reactor 支持自动设置异步工具注册。spring-doc.cadn.net.cn

交通方式

MCP 服务器支持三种传输机制,每种机制都有其专用的Starters:spring-doc.cadn.net.cn

特性和功能

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.SyncToolRegistration> myTools(...) {
    List<McpServerFeatures.SyncToolRegistration> tools = ...
    return tools;
}

资源管理

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

@Bean
public List<McpServerFeatures.SyncResourceRegistration> myResources(...) {
    var systemInfoResource = new McpSchema.Resource(...);
    var resourceRegistration = new McpServerFeatures.SyncResourceRegistration(systemInfoResource, 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(resourceRegistration);
}

及时管理

为服务器提供一种标准化的方法,以便向客户端公开提示模板。spring-doc.cadn.net.cn

@Bean
public List<McpServerFeatures.SyncPromptRegistration> myPrompts() {
    var prompt = new McpSchema.Prompt("greeting", "A friendly greeting prompt",
        List.of(new McpSchema.PromptArgument("name", "The name to greet", true)));

    var promptRegistration = new McpServerFeatures.SyncPromptRegistration(prompt, 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(promptRegistration);
}

根更改使用者

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

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

使用示例

标准 STDIO 服务器配置

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

WebMVC 服务器配置

# Using spring-ai-mcp-server-webmvc-spring-boot-starter
spring:
  ai:
    mcp:
      server:
        name: webmvc-mcp-server
        version: 1.0.0
        type: SYNC
        sse-message-endpoint: /mcp/messages

WebFlux 服务器配置

# Using spring-ai-mcp-server-webflux-spring-boot-starter
spring:
  ai:
    mcp:
      server:
        name: webflux-mcp-server
        version: 1.0.0
        type: ASYNC  # Recommended for reactive applications
        sse-message-endpoint: /mcp/messages

使用 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

示例应用