Skip to main content

​
模型上下文协议客户端

MCP 客户端是模型上下文协议 (MCP) 架构中的关键组件，负责建立和管理与 MCP 服务器的连接。它实现了协议的客户端部分，处理：
  • 协议版本协商，确保与服务器的兼容性
  • 能力协商，确定可用功能
  • 消息传输和 JSON-RPC 通信
  • 工具发现和执行
  • 资源访问和管理
  • 提示系统交互
  • 可选功能，如根节点管理和采样支持
客户端提供同步和异步 API，以便在不同的应用场景中灵活使用。
  • 同步 API
  • 异步 API
// 创建具有自定义配置的同步客户端
McpSyncClient client = McpClient.sync(transport)
    .requestTimeout(Duration.ofSeconds(10))
    .capabilities(ClientCapabilities.builder()
        .roots(true)      // 启用根节点能力
        .sampling()       // 启用采样能力
        .build())
    .sampling(request -> new CreateMessageResult(response))
    .build();

// 初始化连接
client.initialize();

// 列出可用工具
ListToolsResult tools = client.listTools();

// 调用工具
CallToolResult result = client.callTool(
    new CallToolRequest("calculator", 
        Map.of("operation", "add", "a", 2, "b", 3))
);

// 列出和读取资源
ListResourcesResult resources = client.listResources();
ReadResourceResult resource = client.readResource(
    new ReadResourceRequest("resource://uri")
);

// 列出和使用提示
ListPromptsResult prompts = client.listPrompts();
GetPromptResult prompt = client.getPrompt(
    new GetPromptRequest("greeting", Map.of("name", "Spring"))
);

// 添加/删除根节点
client.addRoot(new Root("file:///path", "description"));
client.removeRoot("file:///path");

// 关闭客户端
client.closeGracefully();

​
客户端传输

传输层处理 MCP 客户端和服务器之间的通信，为各种用例提供不同的实现。客户端传输管理消息序列化、连接建立和协议特定的通信模式。
  • STDIO
  • SSE (HttpClient)
  • SSE (WebFlux)
创建基于进程内通信的传输
ServerParameters params = ServerParameters.builder("npx")
    .args("-y", "@modelcontextprotocol/server-everything", "dir")
    .build();
McpTransport transport = new StdioClientTransport(params);

​
客户端能力

客户端可以配置各种能力： 
var capabilities = ClientCapabilities.builder()
    .roots(true)      // 启用带有列表更改通知的文件系统根节点支持
    .sampling()       // 启用 LLM 采样支持
    .build();

​
根节点支持

根节点定义了服务器可以在文件系统中操作的边界： 
// 动态添加根节点
client.addRoot(new Root("file:///path", "description"));

// 删除根节点
client.removeRoot("file:///path");

// 通知服务器根节点变更
client.rootsListChangedNotification();
根节点能力允许服务器：
  • 请求可访问文件系统根节点的列表
  • 在根节点列表变更时接收通知
  • 了解它们可以访问哪些目录和文件

​
采样支持

采样使服务器能够通过客户端请求 LLM 交互（“补全”或”生成”）： 
// 配置采样处理器
Function<CreateMessageRequest, CreateMessageResult> samplingHandler = request -> {
    // 与 LLM 接口的采样实现
    return new CreateMessageResult(response);
};

// 创建具有采样支持的客户端
var client = McpClient.sync(transport)
    .capabilities(ClientCapabilities.builder()
        .sampling()
        .build())
    .sampling(samplingHandler)
    .build();
此能力允许：
  • 服务器利用 AI 功能，而无需 API 密钥
  • 客户端保持对模型访问和权限的控制
  • 支持基于文本和图像的交互
  • 可选在提示中包含 MCP 服务器上下文

​
使用 MCP 客户端

​
工具执行

工具是客户端可以发现和执行的服务器端函数。MCP 客户端提供方法来列出可用工具并使用特定参数执行它们。每个工具都有唯一的名称，并接受参数映射。
  • 同步 API
  • 异步 API
// 列出可用工具及其名称
var tools = client.listTools();
tools.forEach(tool -> System.out.println(tool.getName()));

// 执行带参数的工具
var result = client.callTool("calculator", Map.of(
    "operation", "add",
    "a", 1,
    "b", 2
));

​
资源访问

资源表示客户端可以使用 URI 模板访问的服务器端数据源。MCP 客户端提供方法来发现可用资源，并通过标准化接口检索其内容。
  • 同步 API
  • 异步 API
// 列出可用资源及其名称
var resources = client.listResources();
resources.forEach(resource -> System.out.println(resource.getName()));

// 使用 URI 模板检索资源内容
var content = client.getResource("file", Map.of(
    "path", "/path/to/file.txt"
));

​
提示系统

提示系统支持与服务器端提示模板的交互。这些模板可以被发现并使用自定义参数执行，允许基于预定义模式进行动态文本生成。
  • 同步 API
  • 异步 API
// 列出可用提示模板
var prompts = client.listPrompts();
prompts.forEach(prompt -> System.out.println(prompt.getName()));

// 执行带参数的提示模板
var response = client.executePrompt("echo", Map.of(
    "text", "你好，世界！"
));