README
🚀 运行MCP客户端
本项目提供了一个MCP客户端,可用于连接文件系统服务器并执行各种操作。通过以下步骤,你可以轻松运行客户端并测试服务器。
🚀 快速开始
前提条件
在运行此客户端之前,请确保服务器已启动并正常运行。有关更多信息,请参见:https://github.com/dazzaji/filesystem
📦 安装指南
第一步:创建虚拟环境并正确安装依赖项
使用以下命令创建并激活虚拟环境,然后安装所需依赖:
mkdir mcp-client-py
cd mcp-client-py
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
此命令创建一个虚拟环境,激活它,然后将 mcp 和 python-dotenv(及其依赖项)安装到该环境中。
🔧 配置环境变量
第二步:确认或调整.env文件中的环境变量
创建一个 .env 文件,指定服务器路径和允许目录。您还可以指定测试工具和参数。
SERVER_PATH=/Users/dazzagreenwood/filesystem/dist/index.js
ALLOWED_DIRECTORY=/Users/dazzagreenwood/mcp-hello/module1/files
# 使用以下参数进行测试:
#TOOL=list_directory
#ARGS='{"path": "/Users/dazzagreenwood/mcp-hello/module1/files", "recursive": true}'
# 或使用其他工具进行测试
#TOOL=read_file
#ARGS='{"path": "/Users/dazzagreenwood/mcp-hello/module1/files/test.txt"}'
💻 使用示例
第三步:运行Python客户端
运行您的客户端以测试服务器。
python client.py
- 如果在 .env 文件中指定了可选的
TOOL和ARGS,请像这样添加这些参数:
python client.py --tool "list_directory" --args '{"path": "/Users/dazzagreenwood/mcp-hello/module1/files", "recursive": true}'
此操作将:
- 连接到您的文件系统服务器。
- 列出可用工具。
- 调用
write_file以在指定目录中创建一个测试文件,如果未在 .env 文件中指定工具。 - 将结果显示到控制台。
第四步:验证结果
成功运行客户端后,请检查以下内容:
- 客户端输出:您应该会看到类似
Available tools: [ ... ]的输出,并显示每个操作的结果。 - 文件创建:确认在指定目录中是否正确创建了测试文件。
按照以上说明,您可以使用 Python 和 TypeScript/Node.js 使用各种工具测试 MCP 服务器和客户端!
📚 测试工作流程
启动服务器
- 打开终端窗口并导航到您的服务器项目目录。
- 根据 https://github.com/dazzaji/filesystem 中的说明启动服务器。
使用客户端进行测试
使用 list_directory 工具
python client.py --server-path /Users/dazzagreenwood/filesystem/dist/index.js --allowed-directory /Users/dazzagreenwood/mcp-hello/module1/files --tool list_directory --args '{"path": "/Users/dazzagreenwood/mcp-hello/module1/files", "recursive": true}'
使用 read_file 工具
python client.py --server-path /Users/dazzagreenwood/filesystem/dist/index.js --allowed-directory /Users/dazzagreenwood/mcp-hello/module1/files --tool read_file --args '{"path": "/Users/dazzagreenwood/mcp-hello/module1/files/test.txt"}'
- 根据需要调整路径,使其适用于您的本地环境。
如果配置正确,您应该能够看到每个操作的输出,确认其成功执行。
Scan to join WeChat group