Proxmox MCP Server

Proxmox MCP 服务

这是一个模型上下文协议（MCP）服务，可与 Proxmox VE 服务交互，为大模型提供基础设施上下文。该服务提供多个端点，让大模型能够查询 Proxmox 集群、节点和虚拟机的信息。

功能

• 获取集群范围的信息
• 查询特定节点的详细信息
• 获取虚拟机信息和状态
• 列出集群中的所有虚拟机
• 支持 Docker 和 Docker Compose，便于部署
• 通过环境变量安全地管理凭据

前提条件

• Python 3.11 或更高版本
• Docker 和 Docker Compose
• 可访问 Proxmox VE 服务
• Proxmox API 凭据

安装

1. 克隆代码仓库
2. 将 .env.example 复制为 .env，并更新 Proxmox 凭据：

   cp .env.example .env
   

3. 使用 Proxmox 凭据更新 .env 文件：

   PROXMOX_HOST=your_proxmox_host
   PROXMOX_USER=your_proxmox_user@pam
   PROXMOX_PASSWORD=your_proxmox_password
   PROXMOX_VERIFY_SSL=false
   

使用 Docker Compose 运行

1. 构建并启动容器：

   docker-compose up --build
   

2. 服务将在 http://localhost:8008 上提供

API 端点

MCP 服务提供以下上下文端点：

• get_cluster_info：返回 Proxmox 集群的常规信息
• get_node_info：返回特定 Proxmox 节点的详细信息
• get_vm_info：返回特定虚拟机的详细信息
• list_vms：返回集群中所有虚拟机的列表

开发

如需在本地运行服务进行开发：

1. 创建虚拟环境：

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   

2. 安装依赖项：

   pip install -r requirements.txt
   

3. 运行服务：

   uvicorn src.main:app --reload
   

贡献

1. Fork 代码仓库
2. 创建功能分支：

   git checkout -b feature/my-new-feature
   

3. 运行测试并格式化代码：

   pytest
   black src/ tests/
   flake8 src/ tests/
   

4. 提交更改：

   git commit -am 'Add some feature'
   

5. 推送到分支：

   git push origin feature/my-new-feature
   

6. 提交合并请求

开发指南

• 遵循 PEP 8 风格指南
• 为新功能编写测试
• 必要时更新文档
• 使用类型提示
• 编写清晰的提交信息

许可证

MIT