Kubernetes MCP

🚀 Kubernetes MCP Server

Kubernetes MCP Serverは、デバッグや検査のためにKubernetesリソースへの安全な読み取り専用アクセスを提供するModel Context Protocol (MCP)サーバーです。セキュリティを念頭に設計されており、クラスタ全体の可視性を提供しつつ、リソースの変更は行いません。

https://github.com/user-attachments/assets/89df70b0-65d1-461c-b4ab-84b2087136fa

🚀 クイックスタート

前提条件

• 有効なkubeconfigファイルを持つKubernetesクラスタへのアクセス
• ソースからビルドする場合はGo 1.24以上

インストールオプション

オプション1: Goでインストール（推奨）

go install github.com/kkb0318/kubernetes-mcp@latest

バイナリは$GOPATH/bin/kubernetes-mcp（GOPATHが設定されていない場合は$HOME/go/bin/kubernetes-mcp）に配置されます。

オプション2: ソースからビルド

git clone https://github.com/kkb0318/kubernetes-mcp.git
cd kubernetes-mcp
go build -o kubernetes-mcp .

✨ 主な機能

• 🔒 読み取り専用セキュリティ：Kubernetesリソースを安全に検査し、変更することはできません。
• 🎯 CRDサポート：クラスタ内の任意のCustom Resource Definitions (CRD)とシームレスに動作します。
• 🌐 マルチクラスタサポート：異なるKubernetesコンテキスト間をシームレスに切り替えることができます。
• 🔍 スマートなリソース検出：APIグループの部分文字列（例："flux"でFluxCD、"argo"でArgoCD）でリソースを検索できます。
• ⚡ 高性能：フィルタリングとページネーションによる効率的なリソースクエリ。
• 🛠️ 包括的なツールセット：
  • list_resources：高度なオプションでKubernetesリソースをリストし、フィルタリングします。
  • describe_resource：特定のリソースに関する詳細情報を取得します。
  • get_pod_logs：高度なフィルタリング機能でポッドのログを取得します。
  • list_events：デバッグや監視のためにKubernetesイベントをリストし、フィルタリングします。
  • list_contexts：kubeconfigから利用可能なすべてのKubernetesコンテキストをリストします。

⚙️ 設定

MCPサーバーのセットアップ

サーバーをMCP設定に追加します。

基本設定

自動的に~/.kube/configを使用します。

{
  "mcpServers": {
    "kubernetes": {
      "command": "/path/to/kubernetes-mcp"
    }
  }
}

カスタムkubeconfig

{
  "mcpServers": {
    "kubernetes": {
      "command": "/path/to/kubernetes-mcp",
      "env": {
        "KUBECONFIG": "/path/to/your/kubeconfig"
      }
    }
  }
}

⚠️ 重要提示

/path/to/kubernetes-mcpを実際のバイナリパスに置き換えてください。

スタンドアロンでの使用

# デフォルトのkubeconfig (~/.kube/config)
./kubernetes-mcp

# カスタムkubeconfigパス
KUBECONFIG=/path/to/your/kubeconfig ./kubernetes-mcp

⚠️ 重要提示

検査するKubernetesリソースに対して適切な読み取り権限があることを確認してください。

🛠️ 利用可能なツール

list_resources

高度な機能でKubernetesリソースをリストし、フィルタリングします。

例:

// ラベルセレクターでポッドをリストする
{
  "kind": "Pod",
  "namespace": "default",
  "labelSelector": "app=nginx"
}

// 特定のクラスタコンテキストからポッドをリストする
{
  "kind": "Pod",
  "context": "production-cluster",
  "namespace": "default"
}

// FluxCDリソースを検出する
{
  "kind": "all",
  "groupFilter": "flux"
}

describe_resource

特定のKubernetesリソースに関する詳細情報を取得します。

例:

{
  "kind": "Pod",
  "name": "nginx-pod",
  "namespace": "default"
}

get_pod_logs

高度なフィルタリングオプションでポッドのログを取得します。

例:

{
  "name": "nginx-pod",
  "namespace": "default",
  "tail": 50,
  "since": "5m",
  "timestamps": true
}

list_events

デバッグや監視のために高度なフィルタリングオプションでKubernetesイベントをリストし、フィルタリングします。

例:

// 最近の警告イベントをリストする
{
  "eventType": "Warning",
  "since": "30m"
}

// 特定のポッドのイベントをリストする
{
  "object": "nginx-pod",
  "namespace": "default"
}

// スケジューリング失敗イベントをリストする
{
  "reason": "FailedScheduling",
  "limit": 50
}

list_contexts

kubeconfigファイルから利用可能なすべてのKubernetesコンテキストをリストします。

パラメータ: なし - このツールにはパラメータはありません。

応答例:

{
  "contexts": [
    {
      "name": "production-cluster",
      "is_current": false
    },
    {
      "name": "staging-cluster", 
      "is_current": true
    },
    {
      "name": "development-cluster",
      "is_current": false
    }
  ],
  "current_context": "staging-cluster",
  "total": 3
}

ユースケース: マルチクラスタワークフローに最適で、以下のことができます。

• 利用可能なKubernetesコンテキストを検出する
• 現在のアクティブなコンテキストを識別する
• 複数のクラスタ間での操作を計画する

🌟 高度な機能

🌐 マルチクラスタサポート

コンテキスト切り替えを使用して、複数のKubernetesクラスタでシームレスに作業できます。

• コンテキストパラメータ：すべてのツールがオプションのcontextパラメータをサポートし、クエリするクラスタを指定できます。
• 自動検出：既存のkubeconfigファイルを使用し、利用可能なコンテキストを自動的に検出します。
• デフォルトコンテキスト：コンテキストが指定されていない場合は、kubeconfigからの現在のコンテキストを使用します。
• キャッシュされた接続：接続キャッシュにより、複数のクラスタへの接続を効率的に管理します。

マルチクラスタの例:

// 本番クラスタをクエリする
{
  "kind": "Pod",
  "context": "production-cluster",
  "namespace": "default"
}

// ステージング環境からログを取得する
{
  "name": "api-server",
  "context": "staging-cluster",
  "namespace": "api"
}

// 環境間でリソースを比較する（複数の呼び出しを使用）
{
  "kind": "Deployment",
  "context": "production-cluster",
  "namespace": "app"
}

🎯 カスタムリソース定義 (CRD) サポート

クラスタ内の任意のCRDを自動的に検出し、動作します。list_resourcesまたはdescribe_resourceツールでCRDのKind名を使用するだけです。

🔍 スマートなリソース検出

groupFilterパラメータを使用して、APIグループの部分文字列でリソースを検出します。

🔒 セキュリティと安全性

セキュリティを第一に考慮して構築されています。

• ✅ 読み取り専用アクセス - リソースの作成、変更、削除はできません。
• ✅ 本番環境での安全性 - 本番環境での使用に安全です。
• ✅ 最小限の権限 - クラスタリソースへの読み取りアクセスのみ必要です。
• ✅ 破壊的な操作なし - クラスタに損害を与えることはできません。

🤝 コントリビューション

コントリビューションを歓迎します！すべての変更がサーバーの読み取り専用の性質を維持し、適切なテストを含むことを確認してください。

📄 ライセンス

このプロジェクトはMITライセンスの下でライセンスされています。詳細はLICENSEファイルを参照してください。