Proxmox MCP Server

🚀 Proxmox MCP プロジェクトドキュメント

Proxmox MCPは、Proxmox環境における仮想マシン管理やストレージ管理などの機能を提供するツールです。このドキュメントでは、Proxmox MCPのインストール方法、使用方法、機能概要などについて説明します。

🚀 クイックスタート

Proxmox MCPを使用するには、まずインストールする必要があります。インストール方法については、以下の「📦 インストール」を参照してください。インストールが完了したら、「💻 使用例」で示す手順に従って設定と起動を行います。

📦 インストール

インストール方法

1. PyPI を通じたインストール： pip を使用してインストールします。

   pip install proxmox-mcp
   

2. ソースコードからのインストール： リポジトリをクローンしてインストールします。

   git clone https://github.com/yourusername/proxmox-mcp.git
   cd proxmox-mcp
   python setup.py install
   

💻 使用例

基本的な使用法

設定ファイル

config.example.json を config.json にコピーし、必要に応じて設定を変更します。

MCP サービスの起動

仮想環境で MCP を起動します。

python -m proxmox_mcp.server

✨ 主な機能

MCP は以下の主要な機能を提供します：

• VM 管理：仮想マシンの作成、削除、管理を行います。
• ストレージ管理：ストレージプールの設定と監視を行います。
• ネットワーク管理：ネットワークインターフェイスとファイアウォールルールの管理を行います。
• クラスター状態：Proxmox クラスター全体の状態情報を確認できます。

📚 ドキュメント

ツールガイド

ヘルプの取得

mcp --help を使用して、利用可能なすべてのコマンドとそのオプションを表示します。

開発情報

テストの実行

仮想環境でテストを実行します。

pytest tests/

コードのフォーマット

プロジェクトのコードをフォーマットします。

black .

型チェック

静的型チェックを行います。

mypy .

コード規約

コードスタイルをチェックします。

ruff .

プロジェクト構造

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

📄 ライセンス

MIT ライセンス

許諾条項：

著作権 © [年] [作者名]

このソフトウェアは、無料で使用、複製、変更、配布することができますが、上記の著作権表示とこの許諾表示を保持する必要があります。

このソフトウェアの使用または使用不能に起因する損害や問題について、作者は責任を負いません。

⚠️ 重要提示

この翻訳は参考用です。具体的な内容は、元の英語ドキュメントを参照してください。