面向客户端开发者
开始构建您自己的客户端,该客户端可以与所有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
进行适当的清理 - 完成后关闭连接
- 处理服务器断开连接
- 使用
-
安全性
- 将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控制台获取一个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
进行适当的清理 - 完成后关闭连接
- 处理服务器断开连接
- 使用
-
安全性
- 将API密钥安全地存储在
.env
中 - 验证服务器响应
- 谨慎处理工具权限
- 将API密钥安全地存储在
故障排除
服务器路径问题
- 仔细检查您的服务器脚本路径是否正确
- 如果相对路径不起作用,请使用绝对路径
- 对于Windows用户,请确保在路径中使用正斜杠(/)或转义反斜杠(\)
- 验证服务器文件具有正确的扩展名(Python为.py,Node.js为.js)
正确路径使用示例:
响应时间
- 第一次响应可能需要最多30秒才能返回
- 这是正常的,发生在以下情况时:
- 服务器初始化
- Claude处理查询
- 工具正在执行
- 后续响应通常更快
- 在此初始等待期间不要中断进程
常见错误消息
如果您看到:
FileNotFoundError
:检查您的服务器路径Connection refused
:确保服务器正在运行且路径正确Tool execution failed
:验证工具所需的环境变量是否已设置Timeout error
:考虑增加客户端配置中的超时时间
系统要求
在开始之前,请确保您的系统满足以下要求:
- Mac或Windows电脑
- 已安装Node.js 16或更高版本
- 已安装最新版本的
npm
- Anthropic API密钥(Claude)
设置您的环境
首先,让我们创建并设置我们的项目:
更新您的package.json
以设置type: "module"
和构建脚本:
在项目根目录中创建一个tsconfig.json
:
设置您的API密钥
您需要从Anthropic控制台获取一个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搜索MCP服务器的交互式聊天机器人。该应用程序创建了一个由Anthropic的Claude AI模型驱动的对话界面,可以通过Brave搜索执行互联网搜索,从而实现对实时网络数据的自然语言交互。 您可以在GitHub上找到本教程的完整代码。
系统要求
在开始之前,请确保您的系统满足以下要求:
- Java 17或更高版本
- Maven 3.6+
- npx包管理器
- Anthropic API密钥(Claude)
- Brave搜索API密钥
设置您的环境
-
安装npx(Node Package eXecute): 首先,确保安装npm, 然后运行:
-
克隆仓库:
-
设置您的API密钥:
-
构建应用程序:
-
使用Maven运行应用程序:
请确保您的ANTHROPIC_API_KEY
和BRAVE_API_KEY
密钥安全!
工作原理
该应用程序通过多个组件将Spring AI与Brave搜索MCP服务器集成:
MCP客户端配置
- 在pom.xml中所需的依赖项:
- 应用程序属性(application.yml):
这将激活spring-ai-mcp-client-spring-boot-starter
,以根据提供的服务器配置创建一个或多个McpClient
。
- MCP服务器配置(
mcp-servers-config.json
):
聊天实现
聊天机器人使用Spring AI的ChatClient与MCP工具集成实现:
关键特性:
- 使用Claude AI模型进行自然语言理解
- 通过MCP集成Brave搜索以实现实时网络搜索功能
- 使用InMemoryChatMemory维护对话记忆
- 作为交互式命令行应用程序运行
构建和运行
或
应用程序将启动一个交互式聊天会话,您可以在此提问。聊天机器人将在需要从互联网查找信息以回答您的问题时使用Brave搜索。
聊天机器人可以:
- 使用其内置知识回答问题
- 在需要时使用Brave搜索执行网络搜索
- 记住之前消息中的上下文
- 结合多个来源的信息以提供全面的答案
高级配置
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 控制台 获取 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 调用包装在
try-catch
块中 - 提供清晰且有意义的错误消息
- 优雅地处理网络超时和连接问题
-
安全性
- 将 API 密钥和秘密安全地存储在
local.properties
、环境变量或秘密管理器中 - 验证所有外部响应,以避免意外或不安全的数据使用
- 在使用工具时谨慎处理权限和信任边界
- 将 API 密钥和秘密安全地存储在
故障排除
服务器路径问题
- 仔细检查服务器脚本的路径是否正确
- 如果相对路径不起作用,请使用绝对路径
- 对于 Windows 用户,请确保在路径中使用正斜杠 (/) 或转义的反斜杠 ()
- 确保已安装所需的运行时(Java 需要 java,Node.js 需要 npm,Python 需要 uv)
- 验证服务器文件具有正确的扩展名(Java 为 .jar,Node.js 为 .js,Python 为 .py)
正确路径用法的示例:
响应时间
- 第一次响应可能需要长达 30 秒才能返回
- 这是正常的,发生在以下情况时:
- 服务器初始化
- Claude 处理查询
- 工具正在执行
- 后续响应通常更快
- 在初始等待期间不要中断进程
常见错误消息
如果您看到:
Connection refused
:确保服务器正在运行且路径正确Tool execution failed
:验证工具的所需环境变量是否已设置ANTHROPIC_API_KEY is not set
:检查您的环境变量