Command Executor

🚀 MCP コマンド実行器

MCP コマンド実行器は、MCP プロトコルに基づいて実装されたサーバーで、システムコマンドを安全に実行することができます。このサーバーは、許可リストに登録されたコマンドのみを実行することで、安全性を確保しています。

🚀 クイックスタート

MCP コマンド実行器を使用することで、安全にシステムコマンドを実行できます。以下に、基本的な使い方を説明します。

✨ 主な機能

• MCP プロトコルを通じてコマンドを実行する。
• 許可リストを使用してコマンドをフィルタリングする。
• 環境変数を使用して許可されるコマンドをカスタマイズする。
  • 設定ファイル内のグローバル環境変数。
  • 各コマンドの特定の環境変数。
• コマンドの実行結果をテキスト出力として返す。

📦 インストール

Go インストールコマンドを使用する場合

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  # システムにインストールする

📄 ライセンス

MIT

作者：cnosuke ( x.com/cnosuke )