Command Executor

🚀 MCP 命令執行器

MCP 命令執行器是一個基於 MCP 協議實現的服務器，它允許安全地執行系統命令。該服務器通過僅執行註冊在允許列表中的命令，有效保障了系統的安全性。

🚀 快速開始

MCP 命令執行器是一個基於 MCP 協議的服務器，可安全執行系統命令。要使用該服務器，你需要滿足一些先決條件並完成安裝和配置。

✨ 主要特性

• 協議執行：通過 MCP 協議執行命令。
• 命令過濾：使用允許列表進行命令過濾，確保只有指定命令可執行。
• 環境自定義：可通過環境變量自定義允許的命令，包括配置文件中的全局環境變量和每個命令的特定環境變量。
• 結果返回：命令執行結果以文本輸出形式返回。

📦 安裝指南

先決條件

• Go 1.24 或更高版本
• github.com/metoro-io/mcp-golang
• 其他依賴項在 go.mod 中列出

安裝命令

你可以使用以下命令進行安裝：

go install github.com/cnosuke/mcp-command-exec

或者克隆倉庫並手動構建：

git clone https://github.com/cnosuke/mcp-command-exec.git
cd mcp-command-exec
make build

📚 詳細文檔

配置

服務器通過 YAML 文件（默認：config.yml）進行配置。以下是一個配置示例：

# 日誌配置
log: 'log/mcp-command-exec.log'
debug: false

command_exec:
  allowed_commands:
    - git
    - ls
    - mkdir
    - cd
    - npm
    - npx
    - python
  # 工作目錄設置
  default_working_dir: '/home/user'
  allowed_dirs:
    - '/home/user/projects'
    - '/tmp'
  # 路徑搜索設置
  search_paths:
    - '/usr/local/bin'
    - '/usr/bin'
  path_behavior: 'prepend' # prepend, replace, append
  # 全局環境變量
  environment:
    HOME: '/home/user'
    GOPATH: '/home/user/go'
    GOMODCACHE: '/home/user/go/pkg/mod'
    LANG: 'en_US.UTF-8'

你可以通過環境變量覆蓋配置：

• LOG_PATH：指定日誌文件路徑
• DEBUG：啟用調試模式（true/false）
• ALLOWED_COMMANDS：用逗號分隔的允許命令列表（覆蓋配置文件）

示例：

ALLOWED_COMMANDS=git,ls,cat,echo mcp-command-exec 服務器

日誌記錄

日誌行為通過配置控制：

• 如果 log 在配置文件中設置，則將日誌寫入指定文件
• 如果 log 為空，則不生成日誌
• 設置 debug: true 以啟用更詳細的日誌記錄

命令行參數

啟動服務器時，可以指定各種設置：

./bin/mcp-command-exec 服務器 [選項]

選項：

• --config, -c：指定配置文件路徑（默認： "config.yml"）。

MCP 工具規範

命令執行器

通過 MCP 協議實現命令執行功能。以下是詳細的 API 和使用方法。

配置文件結構

{
  "command_exec": {
    "allowed_commands": [
      "git",
      "ls",
      "mkdir",
      "cd",
      "npm",
      "npx",
      "python"
    ],
    "default_working_dir": "/home/user",
    "allowed_dirs": [
      "/home/user/projects",
      "/tmp"
    ],
    "search_paths": [
      "/usr/local/bin",
      "/usr/bin"
    ],
    "path_behavior": "prepend",
    "environment": {
      "HOME": "/home/user",
      "GOPATH": "/home/user/go",
      "GOMODCACHE": "/home/user/go/pkg/mod",
      "LANG": "en_US.UTF-8"
    }
  }
}

環境變量

通過配置文件中的 environment 字段設置全局環境變量。

允許的命令列表

在 allowed_commands 中指定允許執行的具體命令。例如：

"allowed_commands": [
  "git",
  "ls",
  "mkdir",
  "cd",
  "npm",
  "npx",
  "python"
]

工作目錄設置

默認工作目錄由 default_working_dir 指定，允許的目錄列表在 allowed_dirs 中指定。

路徑搜索行為

通過 path_behavior 字段控制命令路徑搜索的行為。可選值包括：

• prepend：將自定義路徑添加到系統 PATH 的前面
• replace：用自定義路徑完全替換系統 PATH
• append：將自定義路徑添加到系統 PATH 的末尾

安全措施

1. 命令過濾：僅允許指定的命令可以通過。
2. 目錄限制：所有命令必須在允許的目錄中執行。
3. 環境隔離：每個命令運行在一個沙盒環境中，防止相互干擾。

開發信息

項目結構

mcp-command-exec/
├── main.go           # 主程序入口
├── config.yml       # 配置文件
└── Makefile         # 構建腳本

編譯與運行

make build     # 編譯可執行文件
make run      # 運行服務器
make install  # 安裝到系統

🔧 技術細節

項目結構

項目的主要結構如下：

mcp-command-exec/
├── main.go           # 主程序入口
├── config.yml       # 配置文件
└── Makefile         # 構建腳本

編譯與運行

可以使用以下命令進行編譯、運行和安裝：

make build     # 編譯可執行文件
make run      # 運行服務器
make install  # 安裝到系統

📄 許可證

本項目採用 MIT 許可證。

作者：cnosuke ( x.com/cnosuke )