Blazickjp Shell MCP Server

🚀 🖥️ Shell MCP サーバー

AIアプリケーションに安全なシェルコマンド実行機能を追加しましょう！Shell MCPサーバーは、Model Context Protocol用に構築されています。

✨ 主な機能

• 🔒 安全な実行 - コマンドは指定されたディレクトリ内でのみ実行されます。
• 🐚 複数のシェルサポート - bash、sh、cmd、powershellをサポートしています。
• ⏱️ タイムアウト制御 - 長時間実行されるコマンドは自動的に終了されます。
• 🌍 クロスプラットフォーム - UnixとWindowsシステムで動作します。
• 🛡️ セキュリティ重視 - ディレクトリとシェルの検証機能が組み込まれています。

🚀 クイックスタート

📦 インストール

# pipを使用する場合
pip install shell-mcp-server

# uvを使用する場合（推奨）
uv pip install shell-mcp-server

🔌 Claudeデスクトップへの統合

Claude Desktopの設定に以下の内容を追加すると、シェルコマンドの実行が可能になります。

{
    "mcpServers": {
        "shell-mcp-server": {
            "command": "uv",
            "args": [
                "--venv",
                ".venv",
                "python",
                "-m",
                "shell_mcp_server.server",
                "--port",
                "23456"
            ]
        }
    }
}

💻 使用例

基本的な使用法

# サーバーを起動する
uv python -m shell_mcp_server.server --port 23456

# コマンドを送信する
curl http://localhost:23456/shell -X POST -d "echo Hello World!"

高度な使用法

from shell_mcp_server import ShellMCPClient

client = ShellMCPClient("http://localhost:23456")
# コマンドを実行して結果を取得する
result = client.run_command("ls -a")
print(result.stdout)  # 結果を出力する

設定

サーバーは以下の方法で設定できます。

# 起動時に設定ファイルを指定する
uv python -m shell_mcp_server.server --config config.json

config.json の例：

{
    "port": 23456,
    "allowed_commands": ["ls", "echo"],
    "super_users": ["user1", "user2"]
}

🔧 技術詳細

セキュリティ機能

• コマンドホワイトリスト - 指定されたコマンドのみが実行できます。
• スーパーユーザーサポート - 特定のユーザーはコマンド制限を回避できます。
• アクセス制御 - IPなどで接続を制限できます。

開発

開発環境を設定するには、以下の手順を実行します。

# 仮想環境を作成してアクティブにする
uv venv
source .venv/bin/activate

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

# テストを実行する
python -m pytest

# カバレッジ付きでテストを実行する
python -m pytest --cov=shell_mcp_server

貢献

貢献を歓迎します！以下のことができます。

• 🐛 問題を報告する
• 💡 提案をする
• 🔧 プルリクエストを送信する
• 📚 ドキュメントを改善する

📄 ライセンス

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