使用说明
项目简介
本项目 'server-run-commands' 是一个基于 Model Context Protocol (MCP) 实现的服务器,旨在为大型语言模型 (LLM) 客户端提供在本地操作系统上执行命令的能力。通过集成此MCP服务器,LLM 可以调用预定义的工具来运行 shell 命令,并获取命令执行的结果,从而扩展 LLM 的交互能力,使其能够与本地环境进行更深入的集成。
主要功能点
- 执行本地命令:提供 'run-command' 工具,允许 LLM 客户端指定命令并在服务器的操作系统上执行。
- 返回执行结果:工具执行后,服务器会将命令的退出码 (exit code) 和标准输出 (stdout) 返回给 LLM 客户端,以便 LLM 理解命令执行的状态和结果。
- 基于 MCP 标准协议:遵循 Model Context Protocol 标准,确保与兼容 MCP 协议的 LLM 客户端无缝集成。
- 使用 Stdio 传输协议:采用标准输入输出 (stdio) 作为服务器与客户端之间的通信通道,简化部署和配置。
安装步骤
- 克隆仓库
git clone https://github.com/anton-107/server-run-commands.git - 进入项目目录
cd server-run-commands - 安装依赖
npm install - 构建项目
npm run build
服务器配置
要将此 MCP 服务器与 MCP 客户端(例如 Claude Desktop)配合使用,您需要在客户端的配置文件中添加服务器配置信息。以下是一个示例 'claude_desktop_config.json' 配置,您需要根据实际情况修改路径:
{ "mcpServers": { "command-runner": { // 服务器名称,可以自定义 "command": "<PATH TO LOCAL NODE>", // Node.js 可执行文件的路径。例如:/usr/bin/node 或 /usr/local/bin/node。请根据您的Node.js安装路径进行替换。 "args": [ "<PATH TO GIT CLONE FOLDER>/server-run-commands/build/index.js" // 指向 'build/index.js' 文件的路径。请将 '<PATH TO GIT CLONE FOLDER>' 替换为您克隆 'server-run-commands' 仓库的本地绝对路径。 ] } } }
注意:
- 请确保 '<PATH TO LOCAL NODE>' 指向您的 Node.js 可执行文件。您可以使用 'which node' 命令在终端中查找 Node.js 的路径。
- 请将 '<PATH TO GIT CLONE FOLDER>' 替换为您克隆 'server-run-commands' 仓库的实际本地路径。例如,如果您将仓库克隆到 '/Users/yourusername/Documents/server-run-commands',则 '<PATH TO GIT CLONE FOLDER>' 应替换为 '/Users/yourusername/Documents/server-run-commands'。
- 'command-runner' 是您为该服务器定义的名称,可以根据您的喜好进行更改。在客户端中引用此服务器时,请使用相同的名称。
基本使用方法
配置完成后,当 MCP 客户端连接到此服务器时,它将能够发现并调用 'run-command' 工具。LLM 客户端可以通过向 'run-command' 工具提供 'command' 参数来执行本地命令。服务器将执行该命令并将结果返回给 LLM 客户端。具体的工具调用方式取决于您使用的 MCP 客户端的接口。
安全提示: 请谨慎使用此 MCP 服务器,因为它允许 LLM 客户端在本地系统上执行命令。确保您信任使用此服务器的 LLM 客户端,并了解潜在的安全风险。限制可以执行的命令类型和权限是重要的安全措施。
信息
分类
桌面与硬件