Proxmox

🚀 Proxmox MCP 使用ガイド

Proxmox MCPは、Proxmox環境におけるユーザー管理やクラスター操作などの機能を提供するツールです。このドキュメントでは、Proxmox MCPの使用方法や開発に関する情報を提供します。

🚀 クイックスタート

Proxmox MCPを使用する前に、以下の手順を確認してください。

✨ 主な機能

• ユーザーグループの作成と管理
• 仮想マシンでのコマンド実行
• Proxmoxクラスターの状態取得
• 開発におけるテスト、コードフォーマット、型チェック、コード規範チェック

📦 インストール

このドキュメントではインストール手順に関する記載がありません。

💻 使用例

基本的な使用法

ユーザーグループの作成

ユーザーグループを作成する前に、以下の点を理解しておいてください。

• ユーザーグループの名前は一意で、32文字以内である必要があります。
• ユーザーグループの説明は、そのグループの目的を簡潔に記述する必要があります。
• 各ユーザーグループには、後のメンテナンスと管理のために連絡先を設定することをお勧めします。

ツールの使用

VMコマンドの実行

このツールを使用すると、QEMU Guest Agentを介して仮想マシンのコンソールでコマンドを実行できます。

パラメータの説明

• node：仮想マシンが実行されているノードの名前を指定します（必須）。
• vmid：仮想マシンのIDを指定します（必須）。
• command：実行する具体的なコマンドを指定します（必須）。

使用例

execute_vm_command --node <ノード名> --vmid <仮想マシンID> --command <具体的なコマンド>

成功応答の例

{
  "status": "SUCCESS",
  "message": "Command executed successfully"
}

失敗応答の例

{
  "status": "ERROR",
  "message": "VM not found or command execution failed"
}

クラスター状態の取得

このツールは、Proxmoxクラスターの全体的な実行状態を取得するために使用されます。これには、クラスター名、状態、ノード数などの情報が含まれます。

高度な使用法

このドキュメントでは高度な使用法に関する記載がありません。

📚 ドキュメント

開発ガイド

テストの実行

仮想環境を有効にした後、以下のコマンドを実行してテストを実行します。

pytest

コードのフォーマット

black ツールを使用してプロジェクトのコードをフォーマットします。

black .

型チェック

mypy を使用して静的型チェックを実行します。

mypy .

コード規範チェック

ruff ツールを使用してコードのスタイルと規範をチェックします。

ruff .

プロジェクト構造

proxmox-mcp/
├── src/
│   └── proxmox_mcp/
│       ├── server.py          # MCP メインサービスの実装
│       ├── config/            # 設定処理モジュール
│       ├── core/              # コア機能モジュール
│       ├── formatting/        # 出力フォーマットとテーマモジュール
│       ├── tools/             # ツール実装モジュール
│       │   └── console/       # 仮想マシンコンソール操作モジュール
│       └── utils/             # ツールセット（認証、ログなど）
├── tests/                     # テストケースディレクトリ
├── proxmox-config/
│   └── config.example.json    # 設定ファイルの例
├── pyproject.toml            # プロジェクトのメタデータと依存関係管理
└── LICENSE                   # MIT ライセンス

🔧 技術詳細

このドキュメントでは技術詳細に関する記載がありません。

📄 ライセンス

MIT License

Proxmox MCPの詳細な使用方法や開発の詳細については、公式ドキュメントと関連リソースを参照してください。