MCP Terminal

🚀 MCP ターミナルサーバー

安全なターミナル実行サーバーで、モデルコンテキストプロトコル（MCP）を実装しています。このサーバーは、制御されたコマンド実行機能を提供し、セキュリティ機能とリソース制限を備えています。

✨ 主な機能

• コマンド実行：シェルコマンドを実行し、出力とエラー処理をキャプチャします。
• セキュリティ制御：許可されたコマンドを制限し、コマンドインジェクションを防止します。
• リソース制御：
  • コマンドのタイムアウト
  • 最大出力サイズの制限
• MCP プロトコルサポート：
  • 標準の MCP メッセージ形式
  • 機能広告
  • ストリーミング出力のサポート

📦 インストール

ローカルセットアップ

# リポジトリをクローンする
git clone https://github.com/RinardNick/mcp-terminal.git
cd mcp-terminal

# uv を使用して仮想環境を作成し、アクティブ化する
uv venv
source .venv/bin/activate  # または Windows では .venv\Scripts\activate

# 開発依存関係をインストールする
uv pip install -e ".[dev]"

PyPI への公開

# パッケージをビルドする
uv pip install build
python -m build

# PyPI にアップロードする
uv pip install twine
python -m twine upload dist/*

MCP Inspector を使用したテスト

MCP Inspector ツールを使用してサーバーの実装をテストできます。

# inspector をインストールする
npm install -g @modelcontextprotocol/inspector

# サーバーをテストする
npx @modelcontextprotocol/inspector python3 src/mcp_terminal/server.py --allowed-commands "python,pip,git,ls,cd"

テストの実行

# すべてのテストを実行する
pytest tests/

# 特定のテストファイルを実行する
pytest tests/test_terminal.py

# カバレッジを伴って実行する
pytest --cov=mcp_terminal tests/

💻 使用例

Claude Desktop の使用

パッケージが PyPI に公開されたら、以下の手順で使用できます。

1. UV をインストールする（まだインストールされていない場合）：

   pip install uv
   

2. UV を使用してパッケージをインストールする：

   uv pip install mcp-terminal
   

3. Claude Desktop を設定する： Claude Desktop の設定ファイル（macOS では通常 ~/Library/Application Support/Claude/claude_desktop_config.json）を編集します。

   {
     "mcpServers": {
       "terminal": {
         "command": "uv",
         "args": [
           "pip",
           "実行",
           "mcp-terminal",
           "--allowed-commands",
           "python,pip,git,ls,cd",
           "--timeout-ms",
           "30000",
           "--max-output-size",
           "1048576"
         ]
       }
     }
   }
   

📚 ドキュメント

プロトコルの実装

サーバーはモデルコンテキストプロトコル（MCP）を実装しており、以下の機能を備えています。

機能広告

{
  "protocol": "1.0.0",
  "functions": {
    "terminal": {
      "type": "terminal",
      "version": "1.0"
    }
  }
}

メッセージ形式

すべてのメッセージは以下の構造に従います。

{
  "id": string,
  "command": string,
  "args": array,
  "result": any,
  "error": string | null
}

セキュリティに関する考慮事項

• 本番環境では常に allowed-commands を設定してください。
• 保守的なタイムアウトとサイズ制限を使用してください。
• コマンド実行ログを監視してください。

コントリビューション

1. リポジトリをフォークします。
2. 機能ブランチを作成します (git checkout -b feature/amazing-feature)。
3. 変更をコミットします (git commit -m 'いくつかの素晴らしい機能を追加')。
4. ブランチにプッシュします (git push origin feature/amazing-feature)。
5. プルリクエストを開きます。

📄 ライセンス

このプロジェクトは MIT ライセンスの下でライセンスされています。詳細については LICENSE ファイルを参照してください。