面向客户端开发者
轻松打造专属客户端,无缝集成所有MCP服务器!
本教程将教您如何构建一个连接到MCP服务器的LLM驱动聊天机器人客户端。建议您先完成服务器快速入门,它会指导您构建第一个服务器的基础知识。
系统要求
开始前,请确保您的系统满足以下要求:
- Mac或Windows电脑
- 安装最新版Python
- 安装最新版
uv
设置环境
首先,使用uv
创建一个新的Python项目:
设置API密钥
您需要从Anthropic控制台获取Anthropic API密钥。
创建.env
文件来存储它:
将密钥添加到.env
文件中:
将.env
添加到.gitignore
:
创建客户端
基本客户端结构
首先,设置导入并创建基本客户端类:
服务器连接管理
接下来,实现连接到MCP服务器的方法:
查询处理逻辑
现在添加处理查询和处理工具调用的核心功能:
交互式聊天界面
现在添加聊天循环和清理功能:
主入口点
最后,添加主执行逻辑:
关键组件说明
1. 客户端初始化
MCPClient
类使用会话管理和API客户端进行初始化- 使用
AsyncExitStack
进行资源管理 - 配置Anthropic客户端用于Claude交互
2. 服务器连接
- 支持Python和Node.js服务器
- 验证服务器脚本类型
- 设置通信通道
- 初始化会话并列出可用工具
3. 查询处理
- 维护对话上下文
- 处理Claude的响应和工具调用
- 管理Claude和工具之间的消息流
- 将结果组合成连贯的响应
4. 交互式界面
- 提供简单的命令行界面
- 处理用户输入并显示响应
- 包含基本错误处理
- 允许优雅退出
5. 资源管理
- 资源的适当清理
- 连接问题的错误处理
- 优雅关闭程序
常见自定义点
-
工具处理
- 修改
process_query()
以处理特定工具类型 - 为工具调用添加自定义错误处理
- 实现工具特定的响应格式化
- 修改
-
响应处理
- 自定义工具结果格式
- 添加响应过滤或转换
- 实现自定义日志记录
-
用户界面
- 添加GUI或Web界面
- 实现丰富的控制台输出
- 添加命令历史记录或自动补全
运行客户端
要使用任何MCP服务器运行您的客户端:
客户端将:
- 连接到指定的服务器
- 列出可用工具
- 开始交互式聊天会话,您可以:
- 输入查询
- 查看工具执行
- 获取来自Claude的响应
工作原理
当您提交查询时:
- 客户端从服务器获取可用工具列表
- 您的查询与工具描述一起发送给Claude
- Claude决定使用哪些工具(如果有)
- 客户端通过服务器执行请求的工具调用
- 结果发送回Claude
- Claude提供自然语言响应
- 响应显示给您
最佳实践
-
错误处理
- 始终使用try-catch块包装工具调用
- 提供有意义的错误消息
- 优雅处理连接问题
-
资源管理
- 使用
AsyncExitStack
进行适当清理 - 使用完成后关闭连接
- 处理服务器断开连接
- 使用
-
安全性
- 在
.env
中安全存储API密钥 - 验证服务器响应
- 谨慎处理工具权限
- 在
故障排除
服务器路径问题
- 仔细检查服务器脚本路径是否正确
- 如果相对路径不起作用,请使用绝对路径
- Windows用户,确保在路径中使用正斜杠(/)或转义反斜杠(\)
- 验证服务器文件拥有正确的扩展名(.py用于Python或.js用于Node.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
:
创建客户端
基本客户端结构
首先,设置导入并创建基本客户端类:
服务器连接管理
接下来,实现连接到MCP服务器的方法:
查询处理逻辑
现在添加处理查询和处理工具调用的核心功能:
交互式聊天界面
现在添加聊天循环和清理功能:
主入口点
最后,添加主执行逻辑:
关键组件说明
1. 客户端初始化
MCPClient
类使用会话管理和API客户端进行初始化- 使用
AsyncExitStack
进行资源管理 - 配置Anthropic客户端用于Claude交互
2. 服务器连接
- 支持Python和Node.js服务器
- 验证服务器脚本类型
- 设置通信通道
- 初始化会话并列出可用工具
3. 查询处理
- 维护对话上下文
- 处理Claude的响应和工具调用
- 管理Claude和工具之间的消息流
- 将结果组合成连贯的响应
4. 交互式界面
- 提供简单的命令行界面
- 处理用户输入并显示响应
- 包含基本错误处理
- 允许优雅退出
5. 资源管理
- 资源的适当清理
- 连接问题的错误处理
- 优雅关闭程序
常见自定义点
-
工具处理
- 修改
process_query()
以处理特定工具类型 - 为工具调用添加自定义错误处理
- 实现工具特定的响应格式化
- 修改
-
响应处理
- 自定义工具结果格式
- 添加响应过滤或转换
- 实现自定义日志记录
-
用户界面
- 添加GUI或Web界面
- 实现丰富的控制台输出
- 添加命令历史记录或自动补全
运行客户端
要使用任何MCP服务器运行您的客户端:
客户端将:
- 连接到指定的服务器
- 列出可用工具
- 开始交互式聊天会话,您可以:
- 输入查询
- 查看工具执行
- 获取来自Claude的响应
工作原理
当您提交查询时:
- 客户端从服务器获取可用工具列表
- 您的查询与工具描述一起发送给Claude
- Claude决定使用哪些工具(如果有)
- 客户端通过服务器执行请求的工具调用
- 结果发送回Claude
- Claude提供自然语言响应
- 响应显示给您
最佳实践
-
错误处理
- 始终使用try-catch块包装工具调用
- 提供有意义的错误消息
- 优雅处理连接问题
-
资源管理
- 使用
AsyncExitStack
进行适当清理 - 使用完成后关闭连接
- 处理服务器断开连接
- 使用
-
安全性
- 在
.env
中安全存储API密钥 - 验证服务器响应
- 谨慎处理工具权限
- 在
故障排除
服务器路径问题
- 仔细检查服务器脚本路径是否正确
- 如果相对路径不起作用,请使用绝对路径
- Windows用户,确保在路径中使用正斜杠(/)或转义反斜杠(\)
- 验证服务器文件拥有正确的扩展名(.py用于Python或.js用于Node.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控制台获取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块中包装工具调用
- 提供有意义的错误消息
- 优雅处理连接问题
-
安全性
- 在
.env
中安全存储API密钥 - 验证服务器响应
- 对工具权限保持谨慎
- 在
故障排除
服务器路径问题
- 仔细检查服务器脚本路径是否正确
- 如果相对路径不起作用,请使用绝对路径
- 对于Windows用户,确保在路径中使用正斜杠(/)或转义反斜杠(\)
- 验证服务器文件具有正确的扩展名(.js用于Node.js或.py用于Python)
正确路径用法示例:
响应时间
- 第一个响应可能需要30秒才能返回
- 这是正常现象,发生在:
- 服务器初始化
- Claude处理查询
- 工具执行期间
- 后续响应通常更快
- 在初始等待期间不要中断进程
常见错误消息
如果您看到:
Error: Cannot find module
:检查您的构建文件夹并确保TypeScript编译成功Connection refused
:确保服务器正在运行且路径正确Tool execution failed
:验证工具所需的环境变量已设置ANTHROPIC_API_KEY未设置
:检查您的.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
。
spring.ai.mcp.client.toolcallback.enabled=true
属性启用了工具回调机制,自动将所有MCP工具注册为spring ai工具。
该功能默认是禁用的。
- 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控制台获取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的类型系统明确建模错误
- 当可能发生异常时,使用
try-catch
块包装外部工具和API调用 - 提供清晰明确的错误消息
- 优雅处理网络超时和连接问题
-
安全性
- 在
local.properties
、环境变量或密钥管理器中安全存储API密钥和机密 - 验证所有外部响应,避免使用意外或不安全的数据
- 在使用工具时谨慎对待权限和信任边界
- 在
故障排除
服务器路径问题
- 仔细检查服务器脚本路径是否正确
- 如果相对路径不起作用,请使用绝对路径
- 对于Windows用户,确保在路径中使用正斜杠(/)或转义反斜杠(\)
- 确保已安装所需的运行时环境(Java用于Java,npm用于Node.js,或uv用于Python)
- 验证服务器文件具有正确的扩展名(.jar用于Java,.js用于Node.js或.py用于Python)
正确路径用法示例:
响应时间
- 第一个响应可能需要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控制台获取Anthropic API密钥。
创建客户端
基本客户端结构
首先,让我们设置基本的客户端类:
这创建了一个.NET控制台应用程序的基础,可以从用户机密中读取API密钥。
接下来,我们将设置MCP客户端:
确保添加命名空间的using
语句:
这配置了一个MCP客户端,它将连接到作为命令行参数提供的服务器。然后它列出了连接服务器的可用工具。
查询处理逻辑
现在让我们添加处理查询和处理工具调用的核心功能:
关键组件说明
1. 客户端初始化
- 客户端使用
McpClientFactory.CreateAsync()
初始化,该方法设置传输类型和运行服务器的命令。
2. 服务器连接
- 支持Python、Node.js和.NET服务器。
- 使用参数中指定的命令启动服务器。
- 配置使用stdio与服务器通信。
- 初始化会话和可用工具。
3. 查询处理
- 利用Microsoft.Extensions.AI作为聊天客户端。
- 配置
IChatClient
使用自动工具(函数)调用。 - 客户端读取用户输入并发送到服务器。
- 服务器处理查询并返回响应。
- 向用户显示响应。
运行客户端
要使用任何MCP服务器运行您的客户端:
如果您继续使用服务器快速入门中的天气教程,您的命令可能看起来像这样:dotnet run -- 路径/到/QuickstartWeatherServer
。
客户端将:
- 连接到指定的服务器
- 列出可用工具
- 开始交互式聊天会话,您可以:
- 输入查询
- 查看工具执行
- 获取来自Claude的响应
- 完成后退出会话
以下是连接到天气服务器快速入门时应该显示的样子: