MCP 客户端启动器

MCP 客户端启动器

Spring AI MCP（模型上下文协议）客户端启动器为 Spring Boot 应用程序中的 MCP 客户端功能提供自动配置。它支持同步和异步客户端实现，并提供多种传输选项。

MCP 客户端启动器提供：

• 管理多个客户端实例
• 自动客户端初始化（如果启用）
• 支持多种命名传输
• 与 Spring AI 的工具执行框架集成
• 适当的生命周期管理，在应用程序上下文关闭时自动清理资源
• 通过定制器创建可定制的客户端

标准 MCP 客户端

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

标准启动器通过STDIO（进程内）和/或SSE（远程）传输同时连接到一个或多个 MCP 服务器。SSE 连接使用基于 HttpClient 的传输实现。每个与 MCP 服务器的连接都会创建一个新的 MCP 客户端实例。您可以选择SYNC或ASYNCMCP 客户端（注意：不能混合使用同步和异步客户端）。对于生产部署，我们建议使用基于 WebFlux 的 SSE 连接 spring-ai-starter-mcp-client-webflux。

WebFlux 客户端

WebFlux 启动器提供与标准启动器类似的功能，但使用基于 WebFlux 的 SSE 传输实现。

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

配置属性

通用属性

通用属性以下 spring.ai.mcp.client： 列前缀开头

MCP 客户端配置属性

Stdio 传输属性

标准 I/O 传输的属性以 spring.ai.mcp.client.stdio 下列内容为前缀

示例配置：

spring:
  ai:
    mcp:
      client:
        stdio:
          root-change-notification: true
          connections:
            server1:
              command: /path/to/server
              args:
                - --port=8080
                - --mode=production
              env:
                API_KEY: your-api-key
                DEBUG: "true"

或者，您可以使用采用 Claude Desktop 格式的外部 JSON 文件配置 stdio 连接：

spring:
  ai:
    mcp:
      client:
        stdio:
          servers-configuration: classpath:mcp-servers.json

Claude Desktop 格式如下所示：

{
  "mcpServers": {
    "filesystem": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-filesystem",
        "/Users/username/Desktop",
        "/Users/username/Downloads"
      ]
    }
  }
}

目前，Claude Desktop 格式仅支持 STDIO 连接类型。

上交所运输属性

服务器发送事件 (SSE) 传输的属性以spring.ai.mcp.client.sse为前缀：

示例配置：

spring:
  ai:
    mcp:
      client:
        sse:
          connections:
            server1:
              url: http://localhost:8080
            server2:
              url: http://otherserver:8081
              sse-endpoint: /custom-sse

特征

同步/异步客户端类型

该启动器支持两种类型的客户端：

• 同步 - 默认客户端类型，适用于具有阻塞操作的传统请求-响应模式
• 异步 - 适用于具有非阻塞操作的反应式应用程序，使用以下配置 spring.ai.mcp.client.type=ASYNC

客户端定制

自动配置通过回调接口提供了广泛的客户端规范自定义功能。这些自定义器允许您配置 MCP 客户端行为的各个方面，从请求超时到事件处理和消息处理。

定制类型

可以使用以下自定义选项：

• 请求配置- 设置自定义请求超时
• 自定义采样处理程序- 服务器通过客户端向 LLM 请求 LLM 采样（completions或generations）的标准化方式。此流程允许客户端保持对模型访问、选择和权限的控制，同时使服务器能够利用 AI 功能——无需服务器 API 密钥。
• 文件系统（根目录）访问- 客户端向服务器公开文件系统的标准化方式roots。根目录定义了服务器在文件系统中可以操作的边界，使服务器能够了解其有权访问哪些目录和文件。服务器可以向支持客户端请求根目录列表，并在列表更改时收到通知。
• 事件处理程序 ——当某个服务器事件发生时通知客户端的处理程序：
  • 工具变更通知 - 当可用服务器工具列表发生变化时
  • 资源变更通知 - 当可用服务器资源列表发生变化时。
  • 提示更改通知 - 当可用服务器提示列表发生变化时。
• 日志处理程序- 服务器向客户端发送结构化日志消息的标准化方式。客户端可以通过设置最低日志级别来控制日志的详细程度。

McpSyncClientCustomizer您可以为同步客户端或异步客户端实现McpAsyncClientCustomizer，具体取决于您的应用程序的需要。

同步：

@Component
public class CustomMcpSyncClientCustomizer implements McpSyncClientCustomizer {
    @Override
    public void customize(String serverConfigurationName, McpClient.SyncSpec spec) {

        // Customize the request timeout configuration
        spec.requestTimeout(Duration.ofSeconds(30));

        // Sets the root URIs that this client can access.
        spec.roots(roots);

        // Sets a custom sampling handler for processing message creation requests.
        spec.sampling((CreateMessageRequest messageRequest) -> {
            // Handle sampling
            CreateMessageResult result = ...
            return result;
        });

        // Adds a consumer to be notified when the available tools change, such as tools
        // being added or removed.
        spec.toolsChangeConsumer((List<McpSchema.Tool> tools) -> {
            // Handle tools change
        });

        // Adds a consumer to be notified when the available resources change, such as resources
        // being added or removed.
        spec.resourcesChangeConsumer((List<McpSchema.Resource> resources) -> {
            // Handle resources change
        });

        // Adds a consumer to be notified when the available prompts change, such as prompts
        // being added or removed.
        spec.promptsChangeConsumer((List<McpSchema.Prompt> prompts) -> {
            // Handle prompts change
        });

        // Adds a consumer to be notified when logging messages are received from the server.
        spec.loggingConsumer((McpSchema.LoggingMessageNotification log) -> {
            // Handle log messages
        });
    }
}

异步：

@Component
public class CustomMcpAsyncClientCustomizer implements McpAsyncClientCustomizer {
    @Override
    public void customize(String serverConfigurationName, McpClient.AsyncSpec spec) {
        // Customize the async client configuration
        spec.requestTimeout(Duration.ofSeconds(30));
    }
}

该serverConfigurationName参数是应用定制器并为其创建 MCP 客户端的服务器配置的名称。

MCP 客户端自动配置会自动检测并应用在应用程序上下文中找到的任何定制器。

运输支持

自动配置支持多种传输类型：

• 标准 I/O (Stdio)（由 激活spring-ai-starter-mcp-client）
• SSE HTTP（由 激活spring-ai-starter-mcp-client）
• SSE WebFlux（由 激活spring-ai-starter-mcp-client-webflux）

与 Spring AI 集成

启动器可以配置与 Spring AI 工具执行框架集成的工具回调，从而允许将 MCP 工具用作 AI 交互的一部分。此集成默认启用，可通过设置spring.ai.mcp.client.toolcallback.enabled=false属性禁用。

使用示例

application.properties 将适当的启动依赖项添加到您的项目并在或中配置客户端 application.yml：

spring:
  ai:
    mcp:
      client:
        enabled: true
        name: my-mcp-client
        version: 1.0.0
        request-timeout: 30s
        type: SYNC  # or ASYNC for reactive applications
        sse:
          connections:
            server1:
              url: http://localhost:8080
            server2:
              url: http://otherserver:8081
        stdio:
          root-change-notification: false
          connections:
            server1:
              command: /path/to/server
              args:
                - --port=8080
                - --mode=production
              env:
                API_KEY: your-api-key
                DEBUG: "true"

MCP 客户端 bean 将自动配置并可供注入：

@Autowired
private List<McpSyncClient> mcpSyncClients;  // For sync client

// OR

@Autowired
private List<McpAsyncClient> mcpAsyncClients;  // For async client

当启用工具回调（默认行为）时，所有 MCP 客户端注册的 MCP 工具都将作为ToolCallbackProvider实例提供：

@Autowired
private SyncMcpToolCallbackProvider toolCallbackProvider;
ToolCallback[] toolCallbacks = toolCallbackProvider.getToolCallbacks();