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 服務器提供了以下功能：

• 資源信息：
  • 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：即時監控資源的變化

📦 安裝指南

要安裝 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

配置指南

默認配置

啟動服務器時，默認會讀取 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 協議的強大功能，您可以輕鬆實現對集群資源的即時操作和監控。