Proxmox

🚀 Proxmox MCP 使用指南

Proxmox MCP 是一款強大的工具，可用於 Proxmox 相關的用戶組管理、虛擬機命令執行、集群狀態獲取等操作，同時也提供了完善的開發與測試流程。

🚀 快速開始

在使用 Proxmox MCP 之前，你需要了解創建用戶組的規則、工具的使用方法以及開發相關的流程。下面將為你詳細介紹。

✨ 主要特性

• 支持創建用戶組，方便用戶管理。
• 提供工具用於在虛擬機控制檯執行命令和獲取集群狀態。
• 具備完善的開發流程，包括測試、代碼格式化、類型檢查和代碼規範檢查。

📦 安裝指南

文檔未提供安裝步驟，暫不展示。

💻 使用示例

基礎用法

創建用戶組

在創建用戶組之前，請先閱讀並理解以下幾點：

• 用戶組的名稱必須唯一且不超過 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 的詳細使用方法或開發細節，請參考官方文檔和相關資源。