> ## Documentation Index
> Fetch the complete documentation index at: https://startai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# MCP 服务器

> 学习如何实现和配置 Model Context Protocol (MCP) 服务器

<Note>
  ### 0.8.x 版本重大变更 ⚠️

  **注意：** 0.8.x 版本引入了多项重大变更，包括新的基于会话的架构。
  如果您正在从 0.7.0 版本升级，请参考[迁移指南](https://github.com/modelcontextprotocol/java-sdk/blob/main/migration-0.8.0.md)获取详细说明。
</Note>

## 概述

MCP 服务器是 Model Context Protocol (MCP) 架构中的基础组件，为客户端提供工具、资源和功能。它实现了协议的服务器端，负责：

* 暴露可供客户端发现和执行的工具
* 管理基于 URI 的资源访问模式
* 提供提示词模板并处理提示词请求
* 支持与客户端的能力协商
* 实现服务器端协议操作
* 管理并发客户端连接
* 提供结构化日志记录和通知

<Tip>
  核心 `io.modelcontextprotocol.sdk:mcp` 模块提供 STDIO 和 SSE 服务器传输实现，无需依赖外部 Web 框架。

  对于 [Spring Framework](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-client-boot-starter-docs.html) 用户，可以使用 **可选** 依赖 `io.modelcontextprotocol.sdk:mcp-spring-webflux` 和 `io.modelcontextprotocol.sdk:mcp-spring-webmvc` 获取 Spring 特定的传输实现。
</Tip>

服务器同时支持同步和异步 API，可以灵活地集成到不同的应用场景中。

<Tabs>
  <Tab title="同步 API">
    ```java theme={null}
    // 使用自定义配置创建服务器
    McpSyncServer syncServer = McpServer.sync(transportProvider)
        .serverInfo("my-server", "1.0.0")
        .capabilities(ServerCapabilities.builder()
            .resources(true)     // 启用资源支持
            .tools(true)         // 启用工具支持
            .prompts(true)       // 启用提示词支持
            .logging()           // 启用日志支持
            .build())
        .build();

    // 注册工具、资源和提示词
    syncServer.addTool(syncToolSpecification);
    syncServer.addResource(syncResourceSpecification);
    syncServer.addPrompt(syncPromptSpecification);

    // 完成后关闭服务器
    syncServer.close();
    ```
  </Tab>

  <Tab title="异步 API">
    ```java theme={null}
    // 使用自定义配置创建异步服务器
    McpAsyncServer asyncServer = McpServer.async(transportProvider)
        .serverInfo("my-server", "1.0.0")
        .capabilities(ServerCapabilities.builder()
            .resources(true)     // 启用资源支持
            .tools(true)         // 启用工具支持
            .prompts(true)       // 启用提示词支持
            .logging()           // 启用日志支持
            .build())
        .build();

    // 注册工具、资源和提示词
    asyncServer.addTool(asyncToolSpecification)
        .doOnSuccess(v -> logger.info("工具已注册"))
        .subscribe();

    asyncServer.addResource(asyncResourceSpecification)
        .doOnSuccess(v -> logger.info("资源已注册"))
        .subscribe();

    asyncServer.addPrompt(asyncPromptSpecification)
        .doOnSuccess(v -> logger.info("提示词已注册"))
        .subscribe();

    // 完成后关闭服务器
    asyncServer.close()
        .doOnSuccess(v -> logger.info("服务器已关闭"))
        .subscribe();
    ```
  </Tab>
</Tabs>

## 服务器传输提供者

MCP SDK 中的传输层负责处理客户端和服务器之间的通信。它提供了不同的实现以支持各种通信协议和模式。SDK 包含了几个内置的传输提供者实现：

<Tabs>
  <Tab title="STDIO">
    <>
      创建基于进程的传输：

      ```java theme={null}
      StdioServerTransportProvider transportProvider = new StdioServerTransportProvider(new ObjectMapper());
      ```

      通过标准输入/输出流提供双向 JSON-RPC 消息处理，支持非阻塞消息处理、序列化/反序列化和优雅关闭。

      主要特性：

      <ul>
        <li>通过 stdin/stdout 的双向通信</li>
        <li>基于进程的集成支持</li>
        <li>简单的设置和配置</li>
        <li>轻量级实现</li>
      </ul>
    </>
  </Tab>

  <Tab title="SSE (WebFlux)">
    <>
      <p>创建基于 WebFlux 的 SSE 服务器传输。<br />需要 <code>mcp-spring-webflux</code> 依赖。</p>

      ```java theme={null}
      @Configuration
      class McpConfig {
          @Bean
          WebFluxSseServerTransportProvider webFluxSseServerTransportProvider(ObjectMapper mapper) {
              return new WebFluxSseServerTransportProvider(mapper, "/mcp/message");
          }

          @Bean
          RouterFunction<?> mcpRouterFunction(WebFluxSseServerTransportProvider transportProvider) {
              return transportProvider.getRouterFunction();
          }
      }
      ```

      <p>实现 MCP HTTP 与 SSE 传输规范，提供：</p>

      <ul>
        <li>基于 WebFlux 的响应式 HTTP 流式传输</li>
        <li>通过 SSE 端点的并发客户端连接</li>
        <li>消息路由和会话管理</li>
        <li>优雅关闭功能</li>
      </ul>
    </>
  </Tab>

  <Tab title="SSE (WebMvc)">
    <>
      <p>创建基于 WebMvc 的 SSE 服务器传输。<br />需要 <code>mcp-spring-webmvc</code> 依赖。</p>

      ```java theme={null}
      @Configuration
      @EnableWebMvc
      class McpConfig {
          @Bean
          WebMvcSseServerTransportProvider webMvcSseServerTransportProvider(ObjectMapper mapper) {
              return new WebMvcSseServerTransportProvider(mapper, "/mcp/message");
          }

          @Bean
          RouterFunction<ServerResponse> mcpRouterFunction(WebMvcSseServerTransportProvider transportProvider) {
              return transportProvider.getRouterFunction();
          }
      }
      ```

      <p>实现 MCP HTTP 与 SSE 传输规范，提供：</p>

      <ul>
        <li>服务器端事件流</li>
        <li>与 Spring WebMVC 集成</li>
        <li>支持传统 Web 应用</li>
        <li>同步操作处理</li>
      </ul>
    </>
  </Tab>

  <Tab title="SSE (Servlet)">
    <>
      <p>
        创建基于 Servlet 的 SSE 服务器传输。包含在核心 <code>mcp</code> 模块中。<br />
        <code>HttpServletSseServerTransport</code> 可以与任何 Servlet 容器一起使用。<br />
        要在 Spring Web 应用程序中使用它，您可以将其注册为 Servlet bean：
      </p>

      ```java theme={null}
      @Configuration
      @EnableWebMvc
      public class McpServerConfig implements WebMvcConfigurer {

          @Bean
          public HttpServletSseServerTransportProvider servletSseServerTransportProvider() {
              return new HttpServletSseServerTransportProvider(new ObjectMapper(), "/mcp/message");
          }

          @Bean
          public ServletRegistrationBean customServletBean(HttpServletSseServerTransportProvider transportProvider) {
              return new ServletRegistrationBean(transportProvider);
          }
      }
      ```

      <p>
        使用传统 Servlet API 实现 MCP HTTP 与 SSE 传输规范，提供：
      </p>

      <ul>
        <li>使用 Servlet 6.0 异步支持的异步消息处理</li>
        <li>多客户端连接的会话管理</li>

        <li>
          两种类型的端点：

          <ul>
            <li>SSE 端点 (<code>/sse</code>) 用于服务器到客户端的事件</li>
            <li>消息端点（可配置）用于客户端到服务器的请求</li>
          </ul>
        </li>

        <li>错误处理和响应格式化</li>
        <li>优雅关闭支持</li>
      </ul>
    </>
  </Tab>
</Tabs>

## 服务器能力

服务器可以配置各种能力：

```java theme={null}
var capabilities = ServerCapabilities.builder()
    .resources(false, true)  // 启用资源支持，并支持列表变更通知
    .tools(true)            // 启用工具支持，并支持列表变更通知
    .prompts(true)          // 启用提示词支持，并支持列表变更通知
    .logging()              // 启用日志支持（默认启用，日志级别为 INFO）
    .build();
```

### 日志支持

服务器提供结构化日志功能，允许向客户端发送不同严重级别的日志消息：

```java theme={null}
// 向客户端发送日志消息
server.loggingNotification(LoggingMessageNotification.builder()
    .level(LoggingLevel.INFO)
    .logger("custom-logger")
    .data("自定义日志消息")
    .build());
```

客户端可以通过 `mcpClient.setLoggingLevel(level)` 请求控制接收的最低日志级别。低于设置级别的消息将被过滤掉。
支持的日志级别（按严重程度递增排序）：DEBUG (0)、INFO (1)、NOTICE (2)、WARNING (3)、ERROR (4)、CRITICAL (5)、ALERT (6)、EMERGENCY (7)

### 工具规范

Model Context Protocol 允许服务器[暴露工具](/specification/2024-11-05/server/tools/)供语言模型调用。
Java SDK 允许实现带有处理函数的工具规范。
工具使 AI 模型能够执行计算、访问外部 API、查询数据库和操作文件：

<Tabs>
  <Tab title="同步">
    ```java theme={null}
    // 同步工具规范
    var schema = """
                {
                  "type" : "object",
                  "id" : "urn:jsonschema:Operation",
                  "properties" : {
                    "operation" : {
                      "type" : "string"
                    },
                    "a" : {
                      "type" : "number"
                    },
                    "b" : {
                      "type" : "number"
                    }
                  }
                }
                """;
    var syncToolSpecification = new McpServerFeatures.SyncToolSpecification(
        new Tool("calculator", "基础计算器", schema),
        (exchange, arguments) -> {
            // 工具实现
            return new CallToolResult(result, false);
        }
    );
    ```
  </Tab>

  <Tab title="异步">
    ```java theme={null}
    // 异步工具规范
    var schema = """
                {
                  "type" : "object",
                  "id" : "urn:jsonschema:Operation",
                  "properties" : {
                    "operation" : {
                      "type" : "string"
                    },
                    "a" : {
                      "type" : "number"
                    },
                    "b" : {
                      "type" : "number"
                    }
                  }
                }
                """;
    var asyncToolSpecification = new McpServerFeatures.AsyncToolSpecification(
        new Tool("calculator", "基础计算器", schema),
        (exchange, arguments) -> {
            // 工具实现
            return Mono.just(new CallToolResult(result, false));
        }
    );
    ```
  </Tab>
</Tabs>

工具规范包括具有 `name`（名称）、`description`（描述）和 `parameter schema`（参数模式）的工具定义，以及实现工具逻辑的调用处理程序。
函数的第一个参数是用于客户端交互的 `McpAsyncServerExchange`，第二个参数是工具参数的映射。

### 资源规范

资源规范包含资源定义及其处理函数。
资源通过暴露以下数据为 AI 模型提供上下文：文件内容、数据库记录、API 响应、系统信息、应用程序状态。
资源规范示例：

<Tabs>
  <Tab title="同步">
    ```java theme={null}
    // 同步资源规范
    var syncResourceSpecification = new McpServerFeatures.syncResourceSpecification(
        new Resource("custom://resource", "名称", "描述", "mime-type", null),
        (exchange, request) -> {
            // 资源读取实现
            return new ReadResourceResult(contents);
        }
    );
    ```
  </Tab>

  <Tab title="异步">
    ```java theme={null}
    // 异步资源规范
    var asyncResourceSpecification = new McpServerFeatures.asyncResourceSpecification(
        new Resource("custom://resource", "名称", "描述", "mime-type", null),
        (exchange, request) -> {
            // 资源读取实现
            return Mono.just(new ReadResourceResult(contents));
        }
    );
    ```
  </Tab>
</Tabs>

资源规范由资源定义和资源读取处理程序组成。
资源定义包括 `name`（名称）、`description`（描述）和 `MIME type`（MIME 类型）。
处理资源读取请求的函数的第一个参数是 `McpAsyncServerExchange`，用于服务器与连接的客户端进行交互。
第二个参数是 `McpSchema.ReadResourceRequest`。

### 提示词规范

作为[提示词功能](/specification/2024-11-05/server/prompts/)的一部分，MCP 为服务器提供了向客户端暴露提示词模板的标准方式。
提示词规范是 AI 模型交互的结构化模板，支持一致的消息格式化、参数替换、上下文注入、响应格式化和指令模板化。

<Tabs>
  <Tab title="同步">
    ```java theme={null}
    // 同步提示词规范
    var syncPromptSpecification = new McpServerFeatures.syncPromptSpecification(
        new Prompt("greeting", "描述", List.of(
            new PromptArgument("name", "描述", true)
        )),
        (exchange, request) -> {
            // 提示词实现
            return new GetPromptResult(description, messages);
        }
    );
    ```
  </Tab>

  <Tab title="异步">
    ```java theme={null}
    // 异步提示词规范
    var asyncPromptSpecification = new McpServerFeatures.asyncPromptSpecification(
        new Prompt("greeting", "描述", List.of(
            new PromptArgument("name", "描述", true)
        )),
        (exchange, request) -> {
            // 提示词实现
            return Mono.just(new GetPromptResult(description, messages));
        }
    );
    ```
  </Tab>
</Tabs>

提示词定义包括 name（提示词的标识符）、description（提示词的用途）和参数列表（用于模板化的参数）。
处理函数处理请求并返回格式化的模板。
第一个参数是用于客户端交互的 `McpAsyncServerExchange`，第二个参数是 `GetPromptRequest` 实例。

### 在服务器中使用采样

要使用[采样功能](/specification/2024-11-05/client/sampling/)，需要连接到支持采样的客户端。
不需要特殊的服务器配置，但在发出请求前要验证客户端的采样支持。
了解[客户端采样支持](./mcp-client#sampling-support)。

一旦连接到兼容的客户端，服务器就可以请求语言模型生成：

<Tabs>
  <Tab title="同步 API">
    ```java theme={null}
    // 创建服务器
    McpSyncServer server = McpServer.sync(transportProvider)
        .serverInfo("my-server", "1.0.0")
        .build();

    // 定义使用采样的工具
    var calculatorTool = new McpServerFeatures.SyncToolSpecification(
        new Tool("ai-calculator", "使用 AI 执行计算", schema),
        (exchange, arguments) -> {
            // 检查客户端是否支持采样
            if (exchange.getClientCapabilities().sampling() == null) {
                return new CallToolResult("客户端不支持 AI 功能", false);
            }
            
            // 创建采样请求
            McpSchema.CreateMessageRequest request = McpSchema.CreateMessageRequest.builder()
                .messages(List.of(new McpSchema.SamplingMessage(McpSchema.Role.USER,
                    new McpSchema.TextContent("计算: " + arguments.get("expression")))
                .modelPreferences(McpSchema.ModelPreferences.builder()
                    .hints(List.of(
                        McpSchema.ModelHint.of("claude-3-sonnet"),
                        McpSchema.ModelHint.of("claude")
                    ))
                    .intelligencePriority(0.8)  // 优先考虑智能性
                    .speedPriority(0.5)         // 中等速度重要性
                    .build())
                .systemPrompt("你是一个有帮助的计算器助手。只提供数值答案。")
                .maxTokens(100)
                .build();
            
            // 向客户端请求采样
            McpSchema.CreateMessageResult result = exchange.createMessage(request);
            
            // 处理结果
            String answer = result.content().text();
            return new CallToolResult(answer, false);
        }
    );

    // 将工具添加到服务器
    server.addTool(calculatorTool);
    ```
  </Tab>

  <Tab title="异步 API">
    ```java theme={null}
    // 创建服务器
    McpAsyncServer server = McpServer.async(transportProvider)
        .serverInfo("my-server", "1.0.0")
        .build();

    // 定义使用采样的工具
    var calculatorTool = new McpServerFeatures.AsyncToolSpecification(
        new Tool("ai-calculator", "使用 AI 执行计算", schema),
        (exchange, arguments) -> {
            // 检查客户端是否支持采样
            if (exchange.getClientCapabilities().sampling() == null) {
                return Mono.just(new CallToolResult("客户端不支持 AI 功能", false));
            }
            
            // 创建采样请求
            McpSchema.CreateMessageRequest request = McpSchema.CreateMessageRequest.builder()
                .content(new McpSchema.TextContent("计算: " + arguments.get("expression")))
                .modelPreferences(McpSchema.ModelPreferences.builder()
                    .hints(List.of(
                        McpSchema.ModelHint.of("claude-3-sonnet"),
                        McpSchema.ModelHint.of("claude")
                    ))
                    .intelligencePriority(0.8)  // 优先考虑智能性
                    .speedPriority(0.5)         // 中等速度重要性
                    .build())
                .systemPrompt("你是一个有帮助的计算器助手。只提供数值答案。")
                .maxTokens(100)
                .build();
            
            // 向客户端请求采样
            return exchange.createMessage(request)
                .map(result -> {
                    // 处理结果
                    String answer = result.content().text();
                    return new CallToolResult(answer, false);
                });
        }
    );

    // 将工具添加到服务器
    server.addTool(calculatorTool)
        .subscribe();
    ```
  </Tab>
</Tabs>

`CreateMessageRequest` 对象允许您指定：`Content`（模型的输入文本或图像）、`Model Preferences`（模型选择的提示和优先级）、`System Prompt`（模型行为的指令）和 `Max Tokens`（生成响应的最大长度）。

### 日志支持

服务器提供结构化日志功能，允许向客户端发送不同严重级别的日志消息。日志通知只能在现有客户端会话中发送，例如工具、资源和提示词调用。

例如，我们可以从工具处理函数中发送日志消息。在客户端端，您可以注册日志消费者来接收服务器的日志消息，并设置最低日志级别来过滤消息。

```java theme={null}
var mcpClient = McpClient.sync(transport)
        .loggingConsumer(notification -> {
            System.out.println("收到日志消息: " + notification.data());
        })
        .build();

mcpClient.initialize();

mcpClient.setLoggingLevel(McpSchema.LoggingLevel.INFO);

// 调用发送日志通知的工具
CallToolResult result = mcpClient.callTool(new McpSchema.CallToolRequest("logging-test", Map.of()));
```

服务器可以使用工具/资源/提示词处理函数中的 `McpAsyncServerExchange`/`McpSyncServerExchange` 对象发送日志消息：

```java theme={null}
var tool = new McpServerFeatures.AsyncToolSpecification(
    new McpSchema.Tool("logging-test", "测试日志通知", emptyJsonSchema),
    (exchange, request) -> {  

      exchange.loggingNotification( // 使用 exchange 发送日志消息
          McpSchema.LoggingMessageNotification.builder()
            .level(McpSchema.LoggingLevel.DEBUG)
            .logger("test-logger")
            .data("调试消息")
            .build())
        .block();

      return Mono.just(new CallToolResult("日志测试完成", false));
    });

var mcpServer = McpServer.async(mcpServerTransportProvider)
  .serverInfo("test-server", "1.0.0")
  .capabilities(
    ServerCapabilities.builder()
      .logging() // 启用日志支持
      .tools(true)
      .build())
  .tools(tool)
  .build();
```

客户端可以通过 `mcpClient.setLoggingLevel(level)` 请求控制接收的最低日志级别。低于设置级别的消息将被过滤掉。
支持的日志级别（按严重程度递增排序）：DEBUG (0)、INFO (1)、NOTICE (2)、WARNING (3)、ERROR (4)、CRITICAL (5)、ALERT (6)、EMERGENCY (7)

## 错误处理

SDK 通过 McpError 类提供全面的错误处理，涵盖协议兼容性、传输通信、JSON-RPC 消息传递、工具执行、资源管理、提示词处理、超时和连接问题。这种统一的错误处理方法确保在同步和异步操作中实现一致可靠的错误管理。