🚀 Proxmox MCP 项目文档
Proxmox MCP 是一款用于管理 Proxmox 集群的工具，可实现虚拟机管理、存储管理、网络管理等功能，帮助用户更便捷地管理 Proxmox 环境。
🚀 快速开始
你可以按照以下步骤快速安装和启动 Proxmox MCP 服务。
📦 安装指南
安装方式
- 通过 PyPI 安装：使用
pip进行安装，操作简单便捷。
pip install proxmox-mcp
- 从源码安装：克隆仓库并安装，适合需要获取最新代码或进行开发的场景。
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 许可证
许可条款：
版权 © [年份] [作者姓名]
准许免费使用、复制、修改及分发本软件，但需保留以上版权声明和本许可声明。
对于因使用或无法使用该软件而产生的任何损害或问题，作者不承担责任。
⚠️ 重要提示
此翻译仅供参考，具体内容请以原始英文文档为准。