Velero MCP

🚀 Velero MCP 服务器

Velero MCP 服务器是一个开源的模型上下文协议（MCP）服务器，它为运行在任何 Kubernetes 集群内的 Velero 备份和调度资源提供只读、安全、结构化的访问。

该项目允许 AI 代理（如 ChatGPT、Claude、Cursor、GitHub Copilot 等）：

• 🔍 检查 Velero 备份
• 🔄 检查 Velero 调度
• 📄 生成 Velero 备份 YAML 清单
• 🧩 将 Velero 数据作为 MCP 资源进行访问
• 🔐 以只读模式安全地与集群进行交互

此项目帮助平台工程师使用 AI 自动化工作流，同时确保对关键集群配置的零风险、低权限和只读访问。

🚀 快速开始

Velero MCP 服务器为 AI 代理提供了安全访问 Velero 备份和调度资源的途径，可帮助工程师自动化工作流。以下将详细介绍其特性、安装、配置和使用方法。

✨ 主要特性

🔧 MCP 工具

list_velero_backups(namespace?: str)

返回 Velero 备份自定义资源（CR）的列表。

get_velero_backup(name: str, namespace?: str)

返回详细的结构化备份对象。

list_velero_schedules(namespace?: str)

列出 Velero 调度 CR，包括 cron 表达式、暂停状态和上次备份信息。

generate_velero_backup_yaml(...)

为 Velero Backup 生成只读 YAML。

📦 安装指南

git clone https://github.com/YOUR-ORG/velero-mcp-server.git
cd velero-mcp-server

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

pip install -r requirements.txt
pip install .

若用于开发：

pip install ".[dev]"

💻 使用示例

基础用法

列出失败的备份

“调用 list_velero_backups 并过滤出状态为失败的备份。”

检查备份

“使用 get_velero_backup 获取 prod-full 备份的信息，并告诉我包含的命名空间。”

生成清单

“生成一个包含 db 和 logging 命名空间、TTL 为 168 小时的 Velero 备份 YAML。”

生成的 YAML 如下：

apiVersion: velero.io/v1
kind: Backup
metadata:
  name: prod-backup
  namespace: velero
spec:
  includedNamespaces:
    - db
    - logging
  ttl: 168h

📚 详细文档

📦 MCP 资源端点

这些端点允许大语言模型（LLMs）在不调用工具的情况下探索 Velero 的状态。

🏗 架构

• Python 3.10+
• MCP（官方模型上下文协议 SDK）
• Kubernetes Python 客户端
• Pydantic 模型
• 安全、只读设计
• 不使用 kubectl，不执行命令，无副作用

流程如下：

MCP 客户端 → Velero MCP 服务器 → Kubernetes API → Velero CRDs

🔐 安全模型

设计为 100% 安全

服务器从不：

• 创建备份
• 执行恢复操作
• 删除备份对象
• 向 Kubernetes 写入任何内容

仅通过 Kubernetes API 读取自定义资源定义（CRDs）。

需要的基于角色的访问控制（RBAC）：

get, list on:
- backups.velero.io
- schedules.velero.io

⚙️ 配置

环境变量

K8s 认证顺序：

1. 集群内的服务账户
2. $KUBECONFIG
3. ~/.kube/config

▶️ 运行服务器

以标准输入输出模式（MCP 要求）启动服务器：

python -m velero_mcp_server.server

🧩 示例 MCP 客户端配置

ChatGPT MCP 配置

{
  "mcpServers": {
    "velero-mcp": {
      "command": "python",
      "args": ["-m", "velero_mcp_server.server"],
      "env": {
        "KUBECONFIG": "/path/to/kubeconfig",
        "VELERO_NAMESPACE": "velero"
      }
    }
  }
}

Claude 桌面端

"mcpServers": {
  "velero-mcp": {
    "command": "python",
    "args": ["-m", "velero_mcp_server.server"],
    "env": {
      "KUBECONFIG": "/path/to/kubeconfig",
      "VELERO_NAMESPACE": "velero"
    }
  }
}

🛠 开发

运行代码检查工具：

ruff check velero_mcp_server

进行类型检查：

mypy velero_mcp_server

运行测试：

pytest

🤝 贡献

我们欢迎各种形式的贡献：

• 添加 Velero 恢复 / 卷快照支持
• 改进错误处理
• 添加更多 MCP 资源
• 添加 Helm 图表
• 添加日志或指标
• 改进文档

请阅读完整的 CONTRIBUTING.md。

📜 许可证

本项目采用MIT 许可证，允许：

• 商业使用
• 个人使用
• 修改
• 分发

🗺 路线图

计划进行的改进：

• 添加对恢复 CRDs 的支持
• 支持快照对象
• 进行恢复影响分析
• 启用写入模式（需严格的标志控制）
• 发布到 PyPI
• 提供用于集群部署的 Helm 图表

如果您想参与项目方向的规划，请提交一个 issue！