使用说明
Proxmox MCP服务器
这是一个模型上下文协议(MCP)服务器,与Proxmox VE服务器连接,为LLM提供基础架构上下文。服务器公开了各种端点,允许LLM查询有关Proxmox集群、节点和虚拟机的信息。
特性
- 获取集群范围的信息
- 查询特定节点详细信息
- 获取VM信息和状态
- 列出群集中的所有虚拟机
- Docker和Docker Compose支持,易于部署
- 通过环境变量实现安全的凭据管理
先决条件
- Python 3.11或更高版本
- Docker和Docker Compose
- 访问Proxmox VE服务器
- Proxmox API证书
安装
- 克隆存储库
- 复制
.env.example向.env并使用您的Proxmox凭据进行更新:cp .env.example .env - 使用您的Proxmox凭据更新.env文件:
PROXMOX_HOST=your_proxmox_host PROXMOX_USER=your_proxmox_user@pam PROXMOX_PASSWORD=your_proxmox_password PROXMOX_VERIFY_SSL=false
使用Docker Compose运行
-
构建并启动容器:
docker-compose up --build -
服务器将在以下时间可用
http://localhost:8008
API终点
MCP服务器提供以下上下文端点:
get_cluster_info:返回有关Proxmox群集的常规信息get_node_info:返回特定Proxmox节点的详细信息get_vm_info:返回特定VM的详细信息list_vms:返回群集中所有VM的列表
发展
要在本地运行服务器进行开发,请执行以下操作:
-
创建虚拟环境:
python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate -
安装依赖项:
pip install -r requirements.txt -
运行服务器:
uvicorn src.main:app --reload
贡献
- 分叉存储库
- 创建特征分支:
git checkout -b feature/my-new-feature - 运行测试并格式化代码:
pytest black src/ tests/ flake8 src/ tests/ - 提交您的更改:
git commit -am 'Add some feature' - 推到分支:
git push origin feature/my-new-feature - 提交合并请求
开发指南
- 遵循PEP 8风格指南
- 为新功能编写测试
- 必要时更新文档
- 使用类型提示
- 写明确的提交消息
许可证
麻省理工学院