JinDaGe - Proxmox MCP Details

article

README

🚀 Proxmox MCP 使用指南

Proxmox MCP 是一款实用的工具，可帮助用户进行用户组管理、虚拟机命令执行、集群状态获取等操作，同时也为开发者提供了完善的开发与测试流程。

🚀 快速开始

在使用 Proxmox MCP 之前，你需要了解一些基本操作，如创建用户组、使用工具以及开发相关的注意事项。下面将为你详细介绍。

✨ 主要特性

支持创建用户组，方便对用户进行分类管理。
提供工具用于在虚拟机控制台执行命令和获取集群状态。
具备完善的开发指南，包括测试、代码格式化、类型检查和代码规范检查。

📦 安装指南

文档中未提及安装步骤，暂不提供相关内容。

💻 使用示例

基础用法

创建用户组

在创建用户组之前，请先阅读并理解以下几点：

用户组的名称必须唯一且不超过 32 个字符。
用户组的描述需要简明扼要地说明该组的作用。
建议为每个用户组设置一个联系人，以便于后续维护和管理。

执行 VM 命令

此工具允许您通过 QEMU Guest Agent 在虚拟机控制台中执行命令。

# 请求格式
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 的详细使用方法或开发细节，请参考官方文档和相关资源。

Proxmox