Shell MCP Server

🚀 🖥️ Shell MCP サーバー

🚀 Shell MCP サーバーを使用して、あなたの AI アプリケーションに安全なシェルコマンド実行機能を追加しましょう！モデルコンテキストプロトコル用に構築されています。

✨ 主な機能

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

🚀 クイックスタート

インストール

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

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

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

Shell コマンド実行を有効にするために、この内容をあなたの Claude デスクトップ設定に追加してください。

{
    "mcp": {
        "servers": [
            {
                "name": "shell_mcp",
                "class_name": "ShellMCPClient",
                "args": {}
            }
        ]
    }
}

echo '[mcp]\n  servers = [{{name=\"shell_mcp\", class_name=\"ShellMCPClient\", args={}}}]' >> claudia.toml

💻 使用例

基本的な使用法

あなたのコードで ShellMCPClient をインポートして使用します。

from shell_mcp_server import ShellMCPClient

# ShellMCP クライアントインスタンスを作成する
client = ShellMCPClient()

# コマンドを実行する
response = client.execute("echo Hello, World!")
print(response)  # 出力: "Hello, World!\n"

# タイムアウト時間を設定する（オプション）
client.timeout = 10  # 10 秒に設定する

# 引数付きのコマンド
response = client.execute("ls -l", working_dir="/path/to/dir")
print(response)

高度な使用法

以下の設定をカスタマイズすることができます。

• timeout: タイムアウト時間を指定します（デフォルト: 無制限）
• shell_path: シェルインタープリターのパスをカスタマイズします（デフォルト: /bin/sh）
• env: 環境変数をカスタマイズします
• working_dir: 作業ディレクトリを設定します

🔧 開発

開発環境を設定します。

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

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

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

# カバレッジ付きのテスト
python -m pytest --cov=shell_mcp_server

🤝 コントリビューション

コントリビューションを歓迎します！自由に以下のことを行ってください。

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

📄 ライセンス

MIT ライセンス - 詳細は LICENSE を参照してください。