客户端开发者指南
开始构建可以与所有 MCP 服务器集成的客户端
在本教程中,您将学习如何构建一个连接到 MCP 服务器的 LLM 驱动的聊天机器人客户端。建议您先完成服务器快速入门指南,了解构建第一个服务器的基础知识。
系统要求
开始之前,请确保您的系统满足以下要求:
- Mac 或 Windows 计算机
- 安装了最新版本的 Python
- 安装了最新版本的
uv
设置环境
首先,使用 uv
创建一个新的 Python 项目:
设置 API 密钥
您需要从 Anthropic 控制台 获取 Anthropic API 密钥。
创建一个 .env
文件来存储它:
将您的密钥添加到 .env
文件中:
将 .env
添加到 .gitignore
中:
确保您的 ANTHROPIC_API_KEY
安全!
创建客户端
基本客户端结构
首先,设置导入并创建基本客户端类:
服务器连接管理
接下来,我们将实现连接到 MCP 服务器的方法:
查询处理逻辑
现在让我们添加处理查询和工具调用的核心功能:
交互式聊天界面
现在我们将添加聊天循环和清理功能:
主入口点
最后,我们将添加主执行逻辑:
您可以在这里找到完整的 client.py
文件。
关键组件解析
1. 客户端初始化
MCPClient
类初始化会话管理和 API 客户端- 使用
AsyncExitStack
进行适当的资源管理 - 配置 Anthropic 客户端用于 Claude 交互
2. 服务器连接
- 支持 Python 和 Node.js 服务器
- 验证服务器脚本类型
- 设置适当的通信通道
- 初始化会话并列出可用工具
3. 查询处理
- 维护对话上下文
- 处理 Claude 的响应和工具调用
- 管理 Claude 和工具之间的消息流
- 将结果组合成连贯的响应
4. 交互式界面
- 提供简单的命令行界面
- 处理用户输入并显示响应
- 包含基本错误处理
- 允许优雅退出
5. 资源管理
- 适当清理资源
- 连接问题的错误处理
- 优雅的关闭程序
常见自定义点
-
工具处理
- 修改
process_query()
以处理特定工具类型 - 为工具调用添加自定义错误处理
- 实现工具特定的响应格式化
- 修改
-
响应处理
- 自定义工具结果的格式
- 添加响应过滤或转换
- 实现自定义日志记录
-
用户界面
- 添加 GUI 或 Web 界面
- 实现丰富的控制台输出
- 添加命令历史或自动完成
运行客户端
要使用任何 MCP 服务器运行您的客户端:
如果您正在继续服务器快速入门中的天气教程,您的命令可能类似于:python client.py .../weather/src/weather/server.py
客户端将:
- 连接到指定的服务器
- 列出可用工具
- 启动交互式聊天会话,您可以:
- 输入查询
- 查看工具执行
- 获取 Claude 的响应
如果连接到服务器快速入门中的天气服务器,它应该看起来像这样:
工作原理
当您提交查询时:
- 客户端从服务器获取可用工具列表
- 您的查询连同工具描述一起发送给 Claude
- Claude 决定使用哪些工具(如果有)
- 客户端通过服务器执行任何请求的工具调用
- 结果发送回 Claude
- Claude 提供自然语言响应
- 响应显示给您
最佳实践
-
错误处理
- 始终在 try-catch 块中包装工具调用
- 提供有意义的错误消息
- 优雅地处理连接问题
-
资源管理
- 使用
AsyncExitStack
进行适当的清理 - 完成后关闭连接
- 处理服务器断开连接
- 使用
-
安全性
- 在
.env
中安全存储 API 密钥 - 验证服务器响应
- 谨慎处理工具权限
- 在
故障排除
服务器路径问题
- 仔细检查服务器脚本的路径是否正确
- 如果相对路径不起作用,请使用绝对路径
- 对于 Windows 用户,确保在路径中使用正斜杠(/)或转义的反斜杠(\)
- 验证服务器文件具有正确的扩展名(Python 为 .py,Node.js 为 .js)
正确路径用法示例:
响应时间
- 第一个响应可能需要长达 30 秒的时间
- 这是正常的,发生在:
- 服务器初始化
- Claude 处理查询
- 工具正在执行
- 后续响应通常更快
- 在初始等待期间不要中断进程
常见错误消息
如果您看到:
FileNotFoundError
:检查您的服务器路径Connection refused
:确保服务器正在运行且路径正确Tool execution failed
:验证工具所需的环境变量已设置Timeout error
:考虑在客户端配置中增加超时时间
系统要求
开始之前,请确保您的系统满足以下要求:
- Mac 或 Windows 计算机
- 安装了最新版本的 Python
- 安装了最新版本的
uv
设置环境
首先,使用 uv
创建一个新的 Python 项目:
设置 API 密钥
您需要从 Anthropic 控制台 获取 Anthropic API 密钥。
创建一个 .env
文件来存储它:
将您的密钥添加到 .env
文件中:
将 .env
添加到 .gitignore
中:
确保您的 ANTHROPIC_API_KEY
安全!
创建客户端
基本客户端结构
首先,设置导入并创建基本客户端类:
服务器连接管理
接下来,我们将实现连接到 MCP 服务器的方法:
查询处理逻辑
现在让我们添加处理查询和工具调用的核心功能:
交互式聊天界面
现在我们将添加聊天循环和清理功能:
主入口点
最后,我们将添加主执行逻辑:
您可以在这里找到完整的 client.py
文件。
关键组件解析
1. 客户端初始化
MCPClient
类初始化会话管理和 API 客户端- 使用
AsyncExitStack
进行适当的资源管理 - 配置 Anthropic 客户端用于 Claude 交互
2. 服务器连接
- 支持 Python 和 Node.js 服务器
- 验证服务器脚本类型
- 设置适当的通信通道
- 初始化会话并列出可用工具
3. 查询处理
- 维护对话上下文
- 处理 Claude 的响应和工具调用
- 管理 Claude 和工具之间的消息流
- 将结果组合成连贯的响应
4. 交互式界面
- 提供简单的命令行界面
- 处理用户输入并显示响应
- 包含基本错误处理
- 允许优雅退出
5. 资源管理
- 适当清理资源
- 连接问题的错误处理
- 优雅的关闭程序
常见自定义点
-
工具处理
- 修改
process_query()
以处理特定工具类型 - 为工具调用添加自定义错误处理
- 实现工具特定的响应格式化
- 修改
-
响应处理
- 自定义工具结果的格式
- 添加响应过滤或转换
- 实现自定义日志记录
-
用户界面
- 添加 GUI 或 Web 界面
- 实现丰富的控制台输出
- 添加命令历史或自动完成
运行客户端
要使用任何 MCP 服务器运行您的客户端:
如果您正在继续服务器快速入门中的天气教程,您的命令可能类似于:python client.py .../weather/src/weather/server.py
客户端将:
- 连接到指定的服务器
- 列出可用工具
- 启动交互式聊天会话,您可以:
- 输入查询
- 查看工具执行
- 获取 Claude 的响应
如果连接到服务器快速入门中的天气服务器,它应该看起来像这样:
工作原理
当您提交查询时:
- 客户端从服务器获取可用工具列表
- 您的查询连同工具描述一起发送给 Claude
- Claude 决定使用哪些工具(如果有)
- 客户端通过服务器执行任何请求的工具调用
- 结果发送回 Claude
- Claude 提供自然语言响应
- 响应显示给您
最佳实践
-
错误处理
- 始终在 try-catch 块中包装工具调用
- 提供有意义的错误消息
- 优雅地处理连接问题
-
资源管理
- 使用
AsyncExitStack
进行适当的清理 - 完成后关闭连接
- 处理服务器断开连接
- 使用
-
安全性
- 在
.env
中安全存储 API 密钥 - 验证服务器响应
- 谨慎处理工具权限
- 在
故障排除
服务器路径问题
- 仔细检查服务器脚本的路径是否正确
- 如果相对路径不起作用,请使用绝对路径
- 对于 Windows 用户,确保在路径中使用正斜杠(/)或转义的反斜杠(\)
- 验证服务器文件具有正确的扩展名(Python 为 .py,Node.js 为 .js)
正确路径用法示例:
响应时间
- 第一个响应可能需要长达 30 秒的时间
- 这是正常的,发生在:
- 服务器初始化
- Claude 处理查询
- 工具正在执行
- 后续响应通常更快
- 在初始等待期间不要中断进程
常见错误消息
如果您看到:
FileNotFoundError
:检查您的服务器路径Connection refused
:确保服务器正在运行且路径正确Tool execution failed
:验证工具所需的环境变量已设置Timeout error
:考虑在客户端配置中增加超时时间
这是基于 Spring AI MCP 自动配置和启动器的快速入门演示。 要了解如何手动创建同步和异步 MCP 客户端,请参阅 Java SDK 客户端 文档
此示例演示如何构建一个交互式聊天机器人,它结合了 Spring AI 的模型上下文协议 (MCP) 和 Brave Search MCP 服务器。该应用程序创建了一个由 Anthropic 的 Claude AI 模型驱动的对话界面,可以通过 Brave Search 执行互联网搜索,实现与实时网络数据的自然语言交互。 您可以在这里找到本教程的完整代码
系统要求
开始之前,确保您的系统满足以下要求:
- Java 17 或更高版本
- Maven 3.6+
- npx 包管理器
- Anthropic API 密钥 (Claude)
- Brave Search API 密钥
设置环境
- 安装 npx (Node Package eXecute):
首先,确保安装 npm
然后运行:
var chatClient = chatClientBuilder .defaultSystem(“您是有用的助手,是 AI 和 Java 方面的专家”) .defaultTools((Object[]) mcpToolAdapter.toolCallbacks()) .defaultAdvisors(new MessageChatMemoryAdvisor(new InMemoryChatMemory())) .build();
或者
应用程序将启动一个交互式聊天会话,您可以在其中提问。聊天机器人在需要从互联网查找信息来回答您的查询时,将使用 Brave Search。
聊天机器人可以:
- 使用其内置知识回答问题
- 在需要时使用 Brave Search 执行网络搜索
- 记住对话中之前消息的上下文
- 结合多个来源的信息提供全面的答案
高级配置
MCP 客户端支持其他配置选项:
- 通过
McpSyncClientCustomizer
或McpAsyncClientCustomizer
进行客户端自定义 - 具有多种传输类型的多个客户端:
STDIO
和SSE
(服务器发送事件) - 与 Spring AI 的工具执行框架集成
- 自动客户端初始化和生命周期管理
对于基于 WebFlux 的应用程序,您可以使用 WebFlux 启动器:
这提供了类似的功能,但使用基于 WebFlux 的 SSE 传输实现,推荐用于生产部署。