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