Proxmox MCP Server

🚀 Proxmox MCP 項目文檔

Proxmox MCP 是一款用於管理 Proxmox 集群的工具，可實現虛擬機管理、存儲管理、網絡管理等功能，幫助用戶更便捷地管理 Proxmox 環境。

🚀 快速開始

你可以按照以下步驟快速安裝和啟動 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 許可證

許可條款：

版權 © [年份] [作者姓名]

准許免費使用、複製、修改及分發本軟件，但需保留以上版權聲明和本許可聲明。

對於因使用或無法使用該軟件而產生的任何損害或問題，作者不承擔責任。

⚠️ 重要提示

此翻譯僅供參考，具體內容請以原始英文文檔為準。