面向客户端开发者
学习如何构建一个可以与所有 MCP 服务器集成的客户端。
在本教程中,你将学习如何构建一个可以连接到 MCP 服务器的 LLM 驱动的聊天机器人客户端。建议先完成 服务器快速入门 教程,了解构建第一个服务器的基础知识。
系统要求
在开始之前,请确保你的系统满足以下要求:
- Mac 或 Windows 电脑
- 已安装最新版本的 Python
- 已安装最新版本的
uv
设置环境
首先,使用 uv
创建一个新的 Python 项目:
设置 API 密钥
你需要从 Anthropic Console 获取一个 Anthropic API 密钥。
创建一个 .env
文件来存储密钥:
将密钥添加到 .env
文件中:
将 .env
添加到 .gitignore
:
确保安全保管你的 ANTHROPIC_API_KEY
!
创建客户端
基本客户端结构
首先,让我们设置导入并创建基本的客户端类:
服务器连接管理
接下来,我们将实现连接到 MCP 服务器的方法:
查询处理逻辑
现在让我们添加处理查询和处理工具调用的核心功能:
交互式聊天界面
现在我们将添加聊天循环和清理功能:
主入口点
最后,我们将添加主执行逻辑:
你可以在这里找到完整的 client.py
文件 here.
关键组件解释
1. 客户端初始化
MCPClient
类初始化时进行会话管理和 API 客户端配置- 使用
AsyncExitStack
进行资源管理 - 配置 Anthropic 客户端以进行 Claude 交互
2. 服务器连接
- 支持 Python 和 Node.js 服务器
- 验证服务器脚本类型
- 设置正确的通信通道
- 初始化会话并列出可用工具
3. 查询处理
- 维护对话上下文
- 处理 Claude 的响应和工具调用
- 管理 Claude 和工具之间的消息流
- 将结果组合成连贯的响应
4. 交互界面
- 提供简单的命令行界面
- 处理用户输入并显示响应
- 包含基本错误处理
- 允许优雅退出
5. 资源管理
- 正确清理资源
- 处理连接问题的错误
- 优雅关闭程序
常见自定义点
-
工具处理
- 修改
process_query()
以处理特定工具类型 - 添加工具调用的自定义错误处理
- 实现工具特定的响应格式
- 修改
-
响应处理
- 自定义工具结果的格式
- 添加响应过滤或转换
- 实现自定义日志记录
-
用户界面
- 添加 GUI 或 Web 界面
- 实现丰富的控制台输出
- 添加命令历史或自动补全
运行客户端
使用任何 MCP 服务器运行你的客户端:
如果你正在继续服务器快速入门中的天气教程,你的命令可能类似于:python client.py .../quickstart-resources/weather-server-python/weather.py
客户端将:
- 连接到指定的服务器
- 列出可用工具
- 启动一个交互式聊天会话,你可以:
- 输入查询
- 查看工具执行
- 获取 Claude 的响应
以下是连接到服务器快速入门中的天气服务器时的示例:
工作原理
当你提交查询时:
- 客户端从服务器获取可用工具列表
- 你的查询连同工具描述一起发送给 Claude
- Claude 决定使用哪些工具(如果有的话)
- 客户端通过服务器执行任何请求的工具调用
- 结果返回给 Claude
- Claude 提供自然语言响应
- 响应显示给你
最佳实践
-
错误处理
- 始终在 try-catch 块中包装工具调用
- 提供有意义的错误消息
- 优雅处理连接问题
-
资源管理
- 使用
AsyncExitStack
进行正确的清理 - 完成后关闭连接
- 处理服务器断开连接
- 使用
-
安全性
- 将 API 密钥安全地存储在
.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 Console 获取一个 Anthropic API 密钥。
创建一个 .env
文件来存储密钥:
将密钥添加到 .env
文件中:
将 .env
添加到 .gitignore
:
确保安全保管你的 ANTHROPIC_API_KEY
!
创建客户端
基本客户端结构
首先,让我们设置导入并创建基本的客户端类:
服务器连接管理
接下来,我们将实现连接到 MCP 服务器的方法:
查询处理逻辑
现在让我们添加处理查询和处理工具调用的核心功能:
交互式聊天界面
现在我们将添加聊天循环和清理功能:
主入口点
最后,我们将添加主执行逻辑:
你可以在这里找到完整的 client.py
文件 here.
关键组件解释
1. 客户端初始化
MCPClient
类初始化时进行会话管理和 API 客户端配置- 使用
AsyncExitStack
进行资源管理 - 配置 Anthropic 客户端以进行 Claude 交互
2. 服务器连接
- 支持 Python 和 Node.js 服务器
- 验证服务器脚本类型
- 设置正确的通信通道
- 初始化会话并列出可用工具
3. 查询处理
- 维护对话上下文
- 处理 Claude 的响应和工具调用
- 管理 Claude 和工具之间的消息流
- 将结果组合成连贯的响应
4. 交互界面
- 提供简单的命令行界面
- 处理用户输入并显示响应
- 包含基本错误处理
- 允许优雅退出
5. 资源管理
- 正确清理资源
- 处理连接问题的错误
- 优雅关闭程序
常见自定义点
-
工具处理
- 修改
process_query()
以处理特定工具类型 - 添加工具调用的自定义错误处理
- 实现工具特定的响应格式
- 修改
-
响应处理
- 自定义工具结果的格式
- 添加响应过滤或转换
- 实现自定义日志记录
-
用户界面
- 添加 GUI 或 Web 界面
- 实现丰富的控制台输出
- 添加命令历史或自动补全
运行客户端
使用任何 MCP 服务器运行你的客户端:
如果你正在继续服务器快速入门中的天气教程,你的命令可能类似于:python client.py .../quickstart-resources/weather-server-python/weather.py
客户端将:
- 连接到指定的服务器
- 列出可用工具
- 启动一个交互式聊天会话,你可以:
- 输入查询
- 查看工具执行
- 获取 Claude 的响应
以下是连接到服务器快速入门中的天气服务器时的示例:
工作原理
当你提交查询时:
- 客户端从服务器获取可用工具列表
- 你的查询连同工具描述一起发送给 Claude
- Claude 决定使用哪些工具(如果有的话)
- 客户端通过服务器执行任何请求的工具调用
- 结果返回给 Claude
- Claude 提供自然语言响应
- 响应显示给你
最佳实践
-
错误处理
- 始终在 try-catch 块中包装工具调用
- 提供有意义的错误消息
- 优雅处理连接问题
-
资源管理
- 使用
AsyncExitStack
进行正确的清理 - 完成后关闭连接
- 处理服务器断开连接
- 使用
-
安全性
- 将 API 密钥安全地存储在
.env
中 - 验证服务器响应
- 对工具权限保持谨慎
- 将 API 密钥安全地存储在
故障排除
服务器路径问题
- 仔细检查服务器脚本的路径是否正确
- 如果相对路径不起作用,请使用绝对路径
- 对于 Windows 用户,请确保在路径中使用正斜杠(/)或转义的反斜杠(\)
- 确认服务器文件具有正确的扩展名(Python 为 .py,Node.js 为 .js)
正确路径使用示例:
响应时间
- 第一个响应可能需要长达 30 秒的时间返回
- 这是正常的,发生在:
- 服务器初始化期间
- Claude 处理查询期间
- 工具正在执行期间
- 后续响应通常更快
- 在此初始等待期间不要中断进程
常见错误消息
如果你看到:
FileNotFoundError
: 检查你的服务器路径Connection refused
: 确保服务器正在运行且路径正确Tool execution failed
: 验证工具所需的环境变量是否已设置Timeout error
: 考虑增加客户端配置中的超时时间
系统要求
在开始之前,请确保你的系统满足以下要求:
- Mac 或 Windows 电脑
- 已安装 Node.js 17 或更高版本
- 已安装最新版本的
npm
- Anthropic API 密钥(Claude)
设置环境
首先,让我们创建并设置我们的项目:
更新你的 package.json
以设置 type: "module"
和一个构建脚本:
在项目根目录中创建一个 tsconfig.json
:
设置 API 密钥
你需要从 Anthropic Console 获取一个 Anthropic API 密钥。
创建一个 .env
文件来存储密钥:
将 .env
添加到 .gitignore
:
确保安全保管你的 ANTHROPIC_API_KEY
!
创建客户端
基本客户端结构
首先,让我们设置导入并在 index.ts
中创建基本的客户端类:
服务器连接管理
接下来,我们将实现连接到 MCP 服务器的方法:
查询处理逻辑
现在让我们添加处理查询和处理工具调用的核心功能:
交互式聊天界面
现在我们将添加聊天循环和清理功能:
主入口点
最后,我们将添加主执行逻辑:
运行客户端
使用任何 MCP 服务器运行你的客户端:
如果你正在继续服务器快速入门中的天气教程,你的命令可能类似于:node build/index.js .../quickstart-resources/weather-server-typescript/build/index.js
客户端将:
- 连接到指定的服务器
- 列出可用工具
- 启动一个交互式聊天会话,你可以:
- 输入查询
- 查看工具执行
- 获取 Claude 的响应
工作原理
当你提交查询时:
- 客户端从服务器获取可用工具列表
- 你的查询连同工具描述一起发送给 Claude
- Claude 决定使用哪些工具(如果有的话)
- 客户端通过服务器执行任何请求的工具调用
- 结果返回给 Claude
- Claude 提供自然语言响应
- 响应显示给你
最佳实践
-
错误处理
- 使用 TypeScript 的类型系统进行更好的错误检测
- 在 try-catch 块中包装工具调用
- 提供有意义的错误消息
- 优雅处理连接问题
-
安全性
- 将 API 密钥安全地存储在
.env
中 - 验证服务器响应
- 对工具权限保持谨慎
- 将 API 密钥安全地存储在
故障排除
服务器路径问题
- 仔细检查服务器脚本的路径是否正确
- 如果相对路径不起作用,请使用绝对路径
- 对于 Windows 用户,请确保在路径中使用正斜杠(/)或转义的反斜杠(\)
- 确认服务器文件具有正确的扩展名(Node.js 为 .js 或 Python 为 .py)
正确路径使用示例:
响应时间
- 第一个响应可能需要长达 30 秒的时间返回
- 这是正常的,发生在:
- 服务器初始化期间
- Claude 处理查询期间
- 工具正在执行期间
- 后续响应通常更快
- 在此初始等待期间不要中断进程
常见错误消息
如果你看到:
Error: Cannot find module
: 检查你的构建文件夹并确保 TypeScript 编译成功Connection refused
: 确保服务器正在运行且路径正确Tool execution failed
: 验证工具所需的环境变量是否已设置ANTHROPIC_API_KEY is not set
: 检查你的 .env 文件和环境变量TypeError
: 确保你使用了正确的工具参数类型
这是一个基于 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 然后运行:
-
克隆仓库:
-
设置 API 密钥:
-
构建应用程序:
-
使用 Maven 运行应用程序:
确保安全保管你的 ANTHROPIC_API_KEY
和 BRAVE_API_KEY
密钥!
工作原理
该应用程序通过几个组件将 Spring AI 与 Brave Search MCP 服务器集成:
MCP 客户端配置
- 在 pom.xml 中的必需依赖项:
- 应用程序属性(application.yml):
这将激活 spring-ai-starter-mcp-client
以根据提供的服务器配置创建一个或多个 McpClient
。
- MCP 服务器配置(
mcp-servers-config.json
):
聊天实现
聊天机器人使用 Spring AI 的 ChatClient 与 MCP 工具集成实现:
主要功能:
- 使用 Claude AI 模型进行自然语言理解
- 通过 MCP 集成 Brave Search 以实现实时网络搜索功能
- 使用 InMemoryChatMemory 维护对话记忆
- 作为交互式命令行应用程序运行
构建和运行
或
该应用程序将启动一个交互式聊天会话,你可以在其中提问。聊天机器人在需要从互联网上查找信息时将使用 Brave Search 来回答你的查询。
聊天机器人可以:
- 使用其内置知识回答问题
- 在需要时使用 Brave Search 进行网络搜索
- 记住对话中的上下文
- 结合多个来源的信息提供全面的答案
高级配置
MCP 客户端支持其他配置选项:
- 通过
McpSyncClientCustomizer
或McpAsyncClientCustomizer
自定义客户端 - 多个客户端与多种传输类型:
STDIO
和SSE
(服务器发送事件) - 与 Spring AI 的工具执行框架集成
- 自动客户端初始化和生命周期管理
对于基于 WebFlux 的应用程序,你可以使用 WebFlux 启动器:
这提供了类似的功能,但使用基于 WebFlux 的 SSE 传输实现,推荐用于生产部署。
系统要求
在开始之前,请确保你的系统满足以下要求:
- Java 17 或更高版本
- Anthropic API 密钥(Claude)
设置环境
首先,如果你还没有安装 java
和 gradle
,请先安装它们。
你可以从 Oracle JDK 官方网站 下载 java
。
验证你的 java
安装:
现在,让我们创建并设置你的项目:
运行 gradle init
后,你将看到创建项目的选项。
选择 Application 作为项目类型,Kotlin 作为编程语言,Java 17 作为 Java 版本。
或者,你可以使用 IntelliJ IDEA 项目向导 创建一个 Kotlin 应用程序。
创建项目后,添加以下依赖项:
还要将以下插件添加到你的构建脚本中:
设置 API 密钥
你需要从 Anthropic Console 获取一个 Anthropic API 密钥。
设置你的 API 密钥:
确保安全保管你的 ANTHROPIC_API_KEY
!
创建客户端
基本客户端结构
首先,让我们创建基本的客户端类:
服务器连接管理
接下来,我们将实现连接到 MCP 服务器的方法:
还要创建一个辅助函数,将 JsonObject
转换为 Anthropic 的 JsonValue
:
查询处理逻辑
现在让我们添加处理查询和处理工具调用的核心功能:
交互式聊天
我们将添加聊天循环:
主入口点
最后,我们将添加主执行函数:
运行客户端
使用任何 MCP 服务器运行你的客户端:
如果你正在继续服务器快速入门中的天气教程,你的命令可能类似于:java -jar build/libs/kotlin-mcp-client-0.1.0-all.jar .../samples/weather-stdio-server/build/libs/weather-stdio-server-0.1.0-all.jar
客户端将:
- 连接到指定的服务器
- 列出可用工具
- 启动一个交互式聊天会话,你可以:
- 输入查询
- 查看工具执行
- 获取 Claude 的响应
工作原理
以下是一个高层次的工作流程图:
当你提交查询时:
- 客户端从服务器获取可用工具列表
- 你的查询连同工具描述一起发送给 Claude
- Claude 决定使用哪些工具(如果有的话)
- 客户端通过服务器执行任何请求的工具调用
- 结果返回给 Claude
- Claude 提供自然语言响应
- 响应显示给你
最佳实践
-
错误处理
- 利用 Kotlin 的类型系统显式建模错误
- 在可能出现异常的地方包装外部工具和 API 调用
- 提供清晰且有意义的错误消息
- 优雅处理网络超时和连接问题
-
安全性
- 将 API 密钥和机密信息安全地存储在
local.properties
、环境变量或秘密管理器中 - 验证所有外部响应以避免意外或不安全的数据使用
- 在使用工具时对权限和信任边界保持谨慎
- 将 API 密钥和机密信息安全地存储在
故障排除
服务器路径问题
- 仔细检查服务器脚本的路径是否正确
- 如果相对路径不起作用,请使用绝对路径
- 对于 Windows 用户,请确保在路径中使用正斜杠(/)或转义的反斜杠(\)
- 确保已安装所需的运行时(Java 用于 Java,npm 用于 Node.js,或 uv 用于 Python)
- 确认服务器文件具有正确的扩展名(Java 为 .jar,Node.js 为 .js 或 Python 为 .py)
正确路径使用示例:
响应时间
- 第一个响应可能需要长达 30 秒的时间返回
- 这是正常的,发生在:
- 服务器初始化期间
- Claude 处理查询期间
- 工具正在执行期间
- 后续响应通常更快
- 在此初始等待期间不要中断进程
常见错误消息
如果你看到:
Connection refused
: 确保服务器正在运行且路径正确Tool execution failed
: 验证工具所需的环境变量是否已设置ANTHROPIC_API_KEY is not set
: 检查你的环境变量
系统要求
在开始之前,请确保你的系统满足以下要求:
- .NET 8.0 或更高版本
- Anthropic API 密钥(Claude)
- Windows、Linux 或 MacOS
设置环境
首先,创建一个新的 .NET 项目:
然后,将所需的依赖项添加到你的项目中:
设置 API 密钥
你需要从 Anthropic Console 获取一个 Anthropic API 密钥。
创建客户端
基本客户端结构
首先,让我们设置基本的客户端类:
这将创建一个可以从用户机密中读取 API 密钥的 .NET 控制台应用程序的开端。
接下来,我们将设置 MCP 客户端:
请确保添加命名空间的 using
语句:
这将配置一个 MCP 客户端,该客户端将连接到作为命令行参数提供的服务器。然后,它列出来自连接服务器的可用工具。
查询处理逻辑
现在让我们添加处理查询和处理工具调用的核心功能:
关键组件解释
1. 客户端初始化
- 客户端使用
McpClientFactory.CreateAsync()
初始化,设置传输类型和运行服务器的命令。
2. 服务器连接
- 支持 Python、Node.js 和 .NET 服务器。
- 使用参数中指定的命令启动服务器。
- 配置为使用 stdio 与服务器通信。
- 初始化会话和可用工具。
3. 查询处理
- 利用 Microsoft.Extensions.AI 进行聊天客户端。
- 配置
IChatClient
以使用自动工具(函数)调用。 - 客户端读取用户输入并将其发送到服务器。
- 服务器处理查询并返回响应。
- 响应显示给用户。
运行客户端
使用任何 MCP 服务器运行你的客户端:
如果你正在继续服务器快速入门中的天气教程,你的命令可能类似于:dotnet run -- path/to/QuickstartWeatherServer
。
客户端将:
- 连接到指定的服务器
- 列出可用工具
- 启动一个交互式聊天会话,你可以:
- 输入查询
- 查看工具执行
- 获取 Claude 的响应
- 完成后退出会话
以下是连接到天气服务器快速入门时的示例: