Terminal Controller

🚀 ターミナルコントローラ MCP サーバ

このサーバは、Model Context Protocol (MCP) を使用し、標準化されたインターフェースを通じて、安全なターミナルコマンドの実行、ディレクトリのナビゲーション、およびファイルシステム操作を実現します。

✨ 主な機能

• コマンド実行：ファイル管理やシステム操作を含むターミナルコマンドの実行をサポートします。
• ディレクトリナビゲーション：ディレクトリの閲覧とナビゲーション機能を提供します。
• ファイル操作：ファイルの読み取り、書き込み、挿入、削除、更新などの操作が可能です。
• セキュリティ：危険なコマンドの実行を防止するためのセキュリティ機構が組み込まれています。

📦 インストール

システム要件

• オペレーティングシステム：Linux または macOS
• Python バージョン：3.11 以上

インストール手順

1. 以下のコマンドを使用して依存関係をインストールします。

   pip install terminal_controller
   

2. ターミナルコントローラサーバを起動します。

   python -m terminal_controller
   

📚 クライアント設定

対応クライアント

• Claude Desktop
• その他の MCP 互換クライアント

設定例

config.json ファイルに以下の内容を追加します。

{
  "server_address": "localhost:8000",
  "timeout": 3600
}

💻 使用例

基本的な使用法

• コマンドの実行：

  mcp exec "ls -l"
  

• ディレクトリの移動：

  mcp cd /path/to/directory
  

• ファイルの読み取り：

  mcp read_file example.txt
  

高度な使用法

• 内容の挿入：

  mcp insert_file_content example.txt "new content" 5
  

• 内容の削除：

  mcp delete_file_content example.txt 3
  

📚 ドキュメント

コマンド実行

def execute_command(command: str, timeout: int = 3600) -> dict:
    """
    ターミナルコマンドを実行します。
    
    パラメータ:
        command (str): 実行するコマンド
        timeout (int): タイムアウト時間（秒、デフォルトは 3600）
        
    戻り値:
        dict：結果またはエラー情報を含む辞書
    """

ファイル読み取り

def read_file(path: str, start_row: int = None, end_row: int = None) -> str:
    """
    ファイルから内容を読み取ります。
    
    パラメータ:
        path (str): ファイルのパス
        start_row (int, オプション): 開始行（0 ベース）
        end_row (int, オプション): 終了行（0 ベース、含む）
        
    戻り値:
        str：ファイルの内容または指定範囲の内容
    """

🔧 技術詳細

• タイムアウト制御：長時間実行されるコマンドを防止します。
• 危険コマンドのブラックリスト：rm -rf / などの危険な操作をブロックします。
• エラー処理：コマンドの実行環境を隔離し、安全性を確保します。

制限事項

• デフォルトでは、サーバはそれを実行するユーザと同じファイルシステム権限を持ちます。
• 一部の対話型コマンドは、ターミナルが非対話型であるため、正常に動作しない場合があります。

トラブルシューティング

1. Python バージョンが 3.11 以上であることを確認します。
2. クライアントの設定が正しいことを確認します。
3. ターミナルコントローラを直接実行してエラーを確認します。

   python -m terminal_controller
   

4. UVX 関連の問題の場合は、以下を試してみます。

   uvx terminal_controller
   

🤝 貢献

貢献を歓迎します！自由に Pull Request を送信してください。

📄 ライセンス

MIT