MCP K8s Server

🚀 MCP-K8S サーバー

MCP-K8S は、Python をベースとした Kubernetes リソース管理ツールです。モデルコンテキストプロトコル（Model Context Protocol, MCP）を通じて、Kubernetes クラスターのリソースにアクセスし操作することができます。このツールは、複数のリソースタイプをサポートし、Kubernetes リソースの管理と監視に役立つ豊富な機能を提供します。

🚀 クイックスタート

サーバーの起動

MCP-K8S サーバーを起動するには、以下のコマンドを実行します。

python -m mcp_k8s_server.run --kube-config ~/.kube/config

デフォルトでは、サーバーは http://localhost:8000 で動作します。

設定ファイル

設定ファイルを編集することで、サーバーの動作をカスタマイズできます。設定ファイルの形式は以下の通りです。

# config.yaml
server:
  name: mcp-k8s-server
  transport: both  # stdio、sse、または両方をサポート
  port: 8000
  host: 0.0.0.0

kubernetes:
  config_path: ~/.kube/config
  context: default
  namespace: default

接続テスト

サーバーを起動した後は、http://localhost:8000 にアクセスするか、MCP クライアントツールを使用してサーバーとやり取りできます。

📦 インストール

MCP-K8S サーバーをインストールするには、以下のコマンドを実行してください。

pip install mcp-k8s-server

💻 使用例

from mcp_k8s_server.client import MCPClient

client = MCPClient("http://localhost:8000")
pod_info = client.get_resource("k8s://default/pods/my-pod")
namespace_list = client.get_namespaces()

📚 ドキュメント

リソース URI パターン

MCP-K8S サーバーは、以下のリソース URI パターンをサポートしています。

名前空間内のリソース

• k8s://{namespace}/{resource_type} - 指定された名前空間内の特定のタイプのすべてのリソースを取得します。
  • 例：k8s://default/pods - デフォルトの名前空間内のすべての Pod を取得します。
• k8s:///{namespace}/{resource_type}/{name} - 指定された名前空間内の特定のタイプの単一のリソースを取得します。
  • 例：k8s://default/deployments/nginx - デフォルトの名前空間内の nginx という名前の Deployment を取得します。

クラスター全体のリソース

• k8s:///{resource_type} - クラスター全体の特定のタイプのすべてのリソースを取得します。
  • 例：k8s:///nodes - クラスター内のすべてのノードを取得します。
• k8s:///{resource_type}/{name} - クラスター全体の特定のタイプの単一のリソースを取得します。
  • 例：k8s:///nodes/worker-1 - worker-1 という名前のノードを取得します。

サポートされるリソースタイプ

名前空間内のリソース

• pods
• deployments
• services
• persistentvolumeclaims
• events

クラスター全体のリソース

• nodes
• persistentvolumes
• namespaces

MCP ツール

MCP-K8S サーバーは、以下の機能を提供します。

リソース情報

• get_resources：指定されたタイプのすべてのリソースを取得します。
• get_resource：特定のリソースの詳細情報を取得します。
• get_namespaces：すべての利用可能な名前空間を取得します。
• get_events：クラスター内のすべてのイベントを取得します。

リソース操作

• create_pod：新しい Pod を作成します。
• delete_pod：指定された Pod を削除します。
• update_deployment：Deployment の設定を更新します。
• scale_deployment：Deployment のレプリカ数を調整します。

クラスター監視

• list_nodes：すべてのノードの情報を取得します。
• get_node_status：指定されたノードの状態を取得します。
• get_cluster_events：クラスター全体のすべてのイベントを取得します。
• watch_resources：リソースの変更をリアルタイムで監視します。

設定ガイド

デフォルト設定

サーバーを起動すると、デフォルトで config.yaml ファイルの設定が読み込まれます。ファイルが存在しない場合は、以下のコマンドでデフォルト設定を生成できます。

mcp-k8s-server init-config

カスタム設定

config.yaml ファイルを編集することで、サーバーの動作をカスタマイズできます。たとえば、Kubernetes 設定ファイルのパスを指定したり、転送プロトコル（HTTP または SSE）を選択したりできます。

トラブルシューティング

使用中に問題が発生した場合は、以下の一般的な問題を確認してください。

1. Kubernetes クラスターに接続できない：Kubernetes 設定ファイルが有効で、クラスターが実行中であることを確認してください。
2. リソースの取得に失敗する：ネットワーク接続とアクセス許可の設定を確認してください。
3. パフォーマンスの問題：クエリパラメータを最適化し、不要なデータの読み込みを減らしてください。

📄 ライセンス

MCP-K8S サーバーは MIT License に基づいています。完全なライセンス情報は、プロジェクトリポジトリで確認できます。

MCP-K8S サーバーは強力な Kubernetes リソース管理ツールで、開発者やオペレーターが Kubernetes クラスターのリソースをより効率的に管理および監視するのに役立ちます。MCP プロトコルの強力な機能を通じて、クラスターリソースのリアルタイム操作と監視を簡単に実現できます。