Velero MCP

🚀 Velero MCP Server

Velero MCP Server は、オープンソースの Model Context Protocol (MCP) サーバーです。任意のKubernetesクラスタ内で動作するVeleroのバックアップとスケジュールリソースに対して、読み取り専用、安全、構造化されたアクセス を提供します。

このサーバーにより、AIエージェント（ChatGPT、Claude、Cursor、GitHub Copilotなど）は以下の操作が可能になります。

• 🔍 Veleroのバックアップ を調査する
• 🔄 Veleroのスケジュール を調査する
• 📄 VeleroのバックアップYAMLマニフェスト を生成する
• 🧩 Veleroのデータを MCPリソース としてアクセスする
• 🔐 クラスタと 読み取り専用モード で安全にやり取りする

このプロジェクトは、プラットフォームエンジニアがAIを使ってワークフローを自動化するのを支援し、クリティカルなクラスタ構成に対する ゼロリスク、低権限、読み取り専用 のアクセスを保証します。

🚀 クイックスタート

このセクションでは、Velero MCP Serverの概要と基本的な使い方を説明します。

✨ 主な機能

🔧 MCPツール

list_velero_backups(namespace?: str)

VeleroのバックアップCRのリストを返します。

get_velero_backup(name: str, namespace?: str)

詳細な構造化されたバックアップオブジェクトを返します。

list_velero_schedules(namespace?: str)

cron、一時停止状態、最後のバックアップを含むVeleroのスケジュールCRのリストを返します。

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]"

💻 使用例

基本的な使用法

失敗したバックアップの一覧表示

“Call list_velero_backups and filter phase = Failed.”

バックアップの調査

“Use get_velero_backup for prod-full and tell me included namespaces.”

マニフェストの生成

“Generate a Velero backup YAML including namespaces db, logging, TTL=168h.”

生成されるYAMLは以下のようになります。

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

📚 ドキュメント

⭐ このプロジェクトが存在する理由

Veleroは一般的に以下の用途に使用されます。

• Kubernetesの名前空間とクラスタのバックアップ
• 災害復旧
• クラスタの移行
• 永続ボリュームスナップショットの管理

しかし、これまでVeleroのCRDを安全で構造化された方法でLLMベースのツールに公開する MCPサーバーは存在しませんでした。

このプロジェクトは以下を提供します。

• Veleroをクエリするための一貫したAPI
• 強い型付けのモデル
• 完全な読み取り専用の安全性
• LLMに友好的な出力の保証
• GitOpsとの簡単な統合

📦 MCPリソースエンドポイント

これらにより、LLMはツールを呼び出すことなくVeleroの状態を調査できます。

🏗 アーキテクチャ

• Python 3.10+
• MCP（公式のModel Context Protocol SDK）
• Kubernetes Python Client
• Pydanticモデル
• 安全な読み取り専用設計
• kubectl を使用せず、実行も副作用もなし

フローは以下の通りです。

MCP Client → Velero MCP Server → Kubernetes API → Velero CRDs

🔐 セキュリティモデル

100%安全に設計されています

このサーバーは 決して 以下のことを行いません。

• バックアップを作成する
• 復元を実行する
• バックアップオブジェクトを削除する
• Kubernetesに何かを書き込む

Kubernetes APIを介してCRDを読み取るだけです。

RBACが必要です

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

⚙️ 設定

環境変数

K8sの認証順序

1. クラスタ内のServiceAccount
2. $KUBECONFIG
3. ~/.kube/config

▶️ サーバーの起動

サーバーをstdioモードで起動します（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 Desktop

"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のRestore / VolumeSnapshotサポートを追加する
• エラーハンドリングを改善する
• より多くのMCPリソースを追加する
• Helmチャートを追加する
• ロギングやメトリクスを追加する
• ドキュメントを改善する

詳細は CONTRIBUTING.md を読んでください。

📜 ライセンス

このプロジェクトは MITライセンス の下でライセンスされており、以下のことが許可されています。

• 商用利用
• 個人利用
• 修正
• 配布

🗺 ロードマップ

計画されている改善点は以下の通りです。

• Restore CRDのサポートを追加する
• スナップショットオブジェクト
• 復元の影響分析
• 書き込み可能モード（厳格なフラグの背後で）
• PyPIへの公開
• クラスタデプロイ用のHelmチャート

もしこの方向性を形作るのを手伝いたい場合は、イシューを開いてください！