使用Spring AI开发MCP Server的配置与实战

By ref-nobody 创建时间 2025年5月4日 | 本文最后更新于 2025年5月9日 #ai, #mcp, #spring, #翻译

Spring AI MCP(Model Context Protocol)Server Boot Starter 为在 Spring Boot 应用程序中设置 MCP 服务器提供了自动配置功能。它能够将 MCP 服务器的功能与 Spring Boot 的自动配置系统无缝集成。

MCP 服务器启动器提供了以下功能:

  • 自动配置 MCP 服务器组件
  • 支持同步和异步操作模式
  • 提供多种传输层选项
  • 灵活的工具、资源和提示指定
  • 支持变更通知功能

Starters

根据传输的需求,我们有三种starter可以选择:标准的starter,基于webmvc的传输服务和基于webflux的传输服务。

标准的starter

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

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-mcp-server</artifactId>
</dependency>
  • 适用于命令行和桌面工具
  • 无需额外的web依赖

启动器激活了 McpServerAutoConfiguration 自动配置,负责以下功能:

  • 配置基本服务器组件
  • 处理工具、资源和提示的指定
  • 管理服务器功能和变更通知
  • 提供同步和异步服务器实现

基于webmvc的传输服务

支持基于 Spring MVC 的 Server-Sent Events(SSE)服务器传输以及可选的 STDIO 传输,实现完整的 MCP 服务器功能。

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

启动器激活了 McpWebMvcServerAutoConfigurationMcpServerAutoConfiguration 自动配置,以提供以下功能:

  • 基于 Spring MVC 的 HTTP 传输(WebMvcSseServerTransportProvider
  • 自动配置的 Server-Sent Events(SSE)端点
  • 可选的 STDIO 传输(通过设置 spring.ai.mcp.server.stdio=true 启用)
  • 包含了 spring-boot-starter-webmcp-spring-webmvc 依赖项

基于webflux的传输服务

支持基于 Spring WebFlux 的 Server-Sent Events(SSE)服务器传输以及可选的 STDIO 传输,实现完整的 MCP 服务器功能。

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

启动器激活了 McpWebFluxServerAutoConfigurationMcpServerAutoConfiguration 自动配置,以提供以下功能:

  • 基于 Spring WebFlux 的响应式传输(WebFluxSseServerTransportProvider
  • 自动配置的响应式 Server-Sent Events(SSE)端点
  • 可选的 STDIO 传输(通过设置 spring.ai.mcp.server.stdio=true 启用)
  • 包含了 spring-boot-starter-webfluxmcp-spring-webflux 依赖项

属性配置

所有的属性配置以spring.ai.mcp.server开头:

属性描述默认值
enabled启用/禁用 MCP 服务器true
stdio启用/禁用 stdio 传输false
name用于标识的服务器名称mcp-server
version服务器版本1.0.0
type服务器类型(SYNC/ASYNC)SYNC
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/pngimage/png MIME 类型与 generateImage() 工具名称关联
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

同步/异步服务类型

同步服务器默认的服务器类型,由 McpSyncServer 实现。它旨在为您的应用程序提供简单的请求-响应模式。要启用这种服务器类型,请在配置中设置 spring.ai.mcp.server.type=SYNC。启用后,它会自动处理同步工具规范的配置。

异步服务器 – 异步服务器的实现使用 McpAsyncServer,并针对非阻塞操作进行了优化。要启用这种服务器类型,请将您的应用程序配置为 spring.ai.mcp.server.type=ASYNC。这种服务器类型会自动设置异步工具规范,并内置对 Project Reactor 的支持。

特性与功能

MCP 服务器启动器允许服务器向客户端暴露工具、资源和提示。它会根据服务器类型,自动将注册为 Spring Bean 的自定义功能处理器(custom capability handlers)转换为同步或异步规范。

工具

允许服务器暴露可以被语言模型调用的工具。MCP 服务器启动器提供以下功能:

  • 支持变更通知
  • 根据服务器类型,工具会自动转换为同步或异步规范
  • 通过 Spring Bean 自动进行工具规范定义
@Bean
public ToolCallbackProvider myTools(...) {
    List<ToolCallback> tools = ...
    return ToolCallbackProvider.from(tools);
}

或者使用更底层的方式:

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

资源管理

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

  • 静态和动态资源规范
  • 可选的变更通知
  • 支持资源模板
  • 同步与异步资源规范之间的自动转换
  • 通过 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);
}

根变更消费者

当根发生变化时,支持 listChanged 的客户端会发送根变更通知。

  • 支持监控根变更
  • 为响应式应用程序自动转换为异步消费者
  • 可选地通过 Spring Bean 进行注册
@Bean
public BiConsumer<McpSyncServerExchange, List<McpSchema.Root>> rootsChangeHandler() {
    return (exchange, roots) -> {
        logger.info("Registering root resources: {}", roots);
    };
}

代码示例

1. 配置文件

webmvc服务的配置文件定义:

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

2. 工具定义

@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。自动配置会将它们合并。

Leave a Reply

Your email address will not be published. Required fields are marked *

目录