使用说明
项目简介
本项目 'deepin-mcp' 主要提供了一个 Python MCP 客户端,但同时也包含了多个预构建的 MCP 服务器示例,展示了如何基于 'mcp' 库快速搭建 MCP 服务器。这些示例服务器包括:
- Bash Server: 提供执行 Linux bash 命令的工具。
- File Server: 提供文件操作(打开、复制、移动、重命名、删除、创建)的工具。
- Weather Server: 提供查询天气信息的工具。
这些服务器示例可以作为 MCP 后端 供 MCP 客户端连接和调用,帮助开发者理解 MCP 服务器的构建和使用方式。
主要功能点
- 工具注册与执行: 通过 '@mcp.tool()' 装饰器轻松注册 Python 函数为 MCP 工具,供客户端调用。
- 资源访问能力: 示例服务器展示了如何通过工具提供对系统资源(如文件系统、bash 命令、外部 API)的访问能力。
- Stdio 传输协议: 示例服务器默认使用 Stdio 作为传输协议,易于启动和调试。
- 快速搭建: 基于 'fastmcp' 库,可以快速构建和扩展 MCP 服务器功能。
安装步骤
-
克隆仓库
git clone https://github.com/toberyan/deepin-mcp.git cd deepin-mcp -
创建并激活虚拟环境
python -m venv .venv source .venv/bin/activate # 或 .venv\Scripts\activate (Windows) -
安装依赖
pip install -e . pip install mcp openai python-dotenv requests # 示例服务器所需依赖
服务器配置
MCP 服务器是为 MCP 客户端提供服务的后端应用。要让客户端连接到这些示例服务器,您需要配置客户端的服务器启动命令。以下是针对不同示例服务器的配置信息,通常在 MCP 客户端的配置文件或启动参数中指定。
1. Bash Server 配置 (bash_server.py)
{ "server name": "bash", "command": "python", "args": ["servers/bash_server.py"] }
参数注释:
- 'command': 启动服务器的命令,这里使用 'python' 解释器。
- 'args': 命令参数,指定 Bash Server 脚本的路径 'servers/bash_server.py'。
2. File Server 配置 (file_server.py)
{ "server name": "file", "command": "python", "args": ["servers/file_server.py"] }
参数注释:
- 'command': 启动服务器的命令,使用 'python' 解释器。
- 'args': 命令参数,指定 File Server 脚本的路径 'servers/file_server.py'。
3. Weather Server 配置 (weather_server.py)
{ "server name": "weather", "command": "python", "args": ["servers/weather_server.py"] }
参数注释:
- 'command': 启动服务器的命令,使用 'python' 解释器。
- 'args': 命令参数,指定 Weather Server 脚本的路径 'servers/weather_server.py'。
注意: 您需要在 'servers/weather_server.py' 文件中将 'API_KEY = "YOUR_API_KEY"' 替换为您自己的 OpenWeatherMap API 密钥,才能正常使用天气查询工具。
基本使用方法
-
启动服务器
打开终端,激活虚拟环境,然后分别运行以下命令启动不同的示例服务器:
- Bash Server: 'python servers/bash_server.py'
- File Server: 'python servers/file_server.py'
- Weather Server: 'python servers/weather_server.py'
服务器启动后,会监听来自 MCP 客户端的请求。
-
配置并运行 MCP 客户端
参考 'deepin-mcp' 仓库中的 'README.md' 和 'client/client.py',配置 MCP 客户端,指定要连接的服务器类型(例如 Bash Server),并提供相应的服务器启动命令配置。
运行客户端后,您就可以通过自然语言指令,利用示例服务器提供的工具,例如:
- 使用 Bash Server 执行 shell 命令 (例如: "列出当前目录的文件")
- 使用 File Server 进行文件操作 (例如: "创建一个名为 test.txt 的文件")
- 使用 Weather Server 查询天气 (例如: "查询北京的天气")
示例客户端启动命令 (连接 Bash Server):
python client/client.py servers/bash_server.py
请根据您的需求选择并配置相应的服务器,并使用 'client/client.py' 或其他 MCP 客户端进行连接和交互。
信息
分类
网页与API