Command Executor MCP Server

<div align="center">

# command-executor MCP 服务器

   <img src="https://raw.githubusercontent.com/Sunwood-ai-labs/command-executor-mcp-server/refs/heads/master/assets/header.svg" alt="Command Executor MCP Server"/>
   
   <a href="README.md"><img src="https://img.shields.io/badge/english-document-white.svg" alt="EN doc"></a>
   <a href="README.ja.md"><img src="https://img.shields.io/badge/ドキュメント-日本語-white.svg" alt="JA doc"/></a>
</div>

一个用于安全执行预先批准命令的模型上下文协议服务器。

## 🎥 演示

https://github.com/user-attachments/assets/ed763a12-b685-4e0b-b9a5-bc948a590f51

## ✨ 特性

- 通过预先批准的命令列表安全执行命令
- 可通过环境变量配置允许的命令
- 使用 TypeScript 和 MCP SDK 构建
- 通过 stdio 进行通信，实现无缝集成
- 错误处理和安全验证
- 实时命令输出流

## 🚀 安装

安装依赖项：
```bash
npm install

构建服务器：

npm run build

用于自动重建的开发：

npm run watch

⚙️ 配置

🔒 允许的命令

默认情况下，允许以下命令：

• git
• ls
• mkdir
• cd
• npm
• npx
• python

您可以通过设置 ALLOWED_COMMANDS 环境变量来自定义允许的命令：

export ALLOWED_COMMANDS=git,ls,mkdir,python

🔌 Claude Desktop 集成

要与 Claude Desktop 一起使用，请添加服务器配置：

在 MacOS 上：

~/Library/Application Support/Claude/claude_desktop_config.json

在 Windows 上：

%APPDATA%/Claude/claude_desktop_config.json

配置示例：

{
  "mcpServers": {
    "command-executor": {
      "command": "/path/to/command-executor/build/index.js"
    }
  }
}

🛡️ 安全注意事项

command-executor 服务器实施了多项安全措施：

1. 预先批准的命令列表

   • 只能执行显式允许的命令
   • 默认列表具有限制性且注重安全性
   • 命令通过前缀进行验证以防止注入

2. 命令验证

   • 命令前缀验证可防止命令注入
   • 没有 shell 执行，从而提高了安全性
   • 环境变量已正确清理

3. 错误处理

   • 针对未经授权的命令的全面错误处理
   • 用于调试的清晰错误消息
   • 失败的命令不会使服务器崩溃

4. 环境隔离

   • 服务器在其自己的环境中运行
   • 可以控制环境变量
   • 有限的系统访问

💻 开发

📁 项目结构

command-executor/
├─ src/
│  └─ index.ts      # 主要服务器实现
├─ build/
│  └─ index.js      # 编译后的 JavaScript
├─ assets/
│  └─ header.svg    # 项目标题图片
└─ package.json     # 项目配置

🐛 调试

由于 MCP 服务器通过 stdio 进行通信，因此调试可能具有挑战性。 我们建议使用 MCP Inspector：

npm run inspector

Inspector 将提供一个 URL 以访问浏览器中的调试工具。

🛠️ 工具 API

服务器提供一个工具：

execute_command

执行预先批准的命令。

参数：

• command (string, required): 要执行的命令

示例请求：

{
  "name": "execute_command",
  "arguments": {
    "command": "git status"
  }
}

示例响应：

{
  "content": [
    {
      "type": "text",
      "text": "On branch main\nNothing to commit, working tree clean"
    }
  ]
}

错误响应：

{
  "content": [
    {
      "type": "text",
      "text": "Command execution failed: Command not allowed"
    }
  ],
  "isError": true
}

❌ 错误处理

服务器为各种场景提供详细的错误消息：

1. 未经授权的命令

   {
     "code": "InvalidParams",
     "message": "Command not allowed: [command]. Allowed commands: git, ls, mkdir, cd, npm, npx, python"
   }
   

2. 执行失败

   {
     "content": [
       {
         "type": "text",
         "text": "Command execution failed: [error message]"
       }
     ],
     "isError": true
   }
   

🤝 贡献

1. Fork 存储库
2. 创建您的功能分支
3. 提交您的更改
4. 推送到分支
5. 创建新的 Pull Request

📄 许可证

该项目已获得 MIT 许可证的许可 - 有关详细信息，请参阅 LICENSE 文件。