Kubeview MCP

🚀 KubeView MCP – Kubernetes模型上下文協議服務器

KubeView 是一個只讀的模型上下文協議（MCP）服務器，它能讓AI代理（如Cursor IDE、Claude Code CLI、Codex CLI、Gemini CLI等）安全地檢查、診斷和調試Kubernetes集群。它為Kubernetes、Helm、Argo Workflows和Argo CD提供了一套全面的工具。 想了解更多關於代碼模式的好處和實現方式，請閱讀 從Kubernetes集群中排除MCP工具調用。

✨ 主要特性

• 🧠 代碼模式：提供沙盒化的TypeScript環境，適用於複雜推理和多步驟工作流。
• 🛡️ 只讀且安全：專為生產環境安全設計，無寫入權限，並對敏感數據進行掩碼處理。
• ☸️ Kubernetes集成：可列出/獲取資源、獲取指標、流式傳輸日誌和事件、執行命令，還具備診斷網絡問題的工具。
• 📦 Helm支持：可檢查版本、值、清單和歷史記錄。
• 🐙 Argo生態系統：可使用直接的Kubernetes API或CLI管理Argo Workflows和Argo CD應用程序。

🚀 快速開始

前提條件

• Node.js ≥ 18
• 能夠訪問Kubernetes集群
• 可選擇在當前$PATH中安裝以下CLI工具：helm、argo、argocd

安裝

# 啟動服務器
npx -y kubeview-mcp

# 作為Claude代碼MCP服務器安裝
claude mcp add kubernetes -- npx kubeview-mcp

MCP客戶端配置

將以下內容添加到你的mcpServers配置中（例如在Cursor或Claude Desktop中）：

{
  "mcpServers": {
    "kubeview": {
      "command": "npx",
      "args": ["-y", "kubeview-mcp"]
    }
  }
}

環境變量

使用環境變量配置服務器：

🛠️ 工具概述

Kubernetes

• kube_list：列出資源或獲取集群診斷信息。
• kube_get：描述特定資源（支持所有K8s類型）。
• kube_metrics：獲取節點和Pod的CPU/內存指標。
• kube_logs：獲取或流式傳輸容器日誌。
• kube_exec：在容器中執行命令（建議只讀）。
• kube_port：端口轉發到Pod/服務。
• kube_net：運行集群內網絡診斷。

Helm

• helm_list：列出Helm版本。
• helm_get：獲取版本值、清單和歷史記錄。

Argo

• argo_list / argo_get：管理Argo Workflows。
• argocd_app：檢查Argo CD應用程序和資源。

實用工具

• run_code：執行沙盒化的TypeScript代碼以處理複雜任務。

🧠 代碼模式

受 使用MCP執行代碼 的啟發，KubeView附帶了一個代碼模式運行時，允許代理在沙盒環境中探索API、搜索工具並執行復雜的工作流。

提供的功能

• MCP橋接層：無縫連接到所有已註冊的MCP服務器工具。
• 動態TypeScript定義：自動將工具模式轉換為強類型的global.d.ts資源，使代理能夠使用有效的TypeScript模式，並在不產生參數幻覺的情況下享受類型安全。
• 工具搜索實用程序：運行時輔助工具，如tools.search()和tools.list()，允許代理逐步發現功能，而無需事先加載整個模式上下文。
• 沙盒執行：通過vm實現的受限Node.js環境，對console和tools全局對象進行了訪問控制，確保安全執行代理生成的代碼。

使用方法

對於需要邏輯、循環或數據處理的複雜任務，請使用 代碼模式：

"env": { "MCP_MODE": "code" }

💡 代碼模式提示技巧

服務器包含一個名為 code-mode 的內置提示，它會將完整的TypeScript API文檔、工具概述和示例注入到上下文中。

在Cursor IDE中： 只需在提示框中輸入/kubeview/code-mode（或從/提示菜單中選擇）。這將為AI提供編寫正確run_code腳本所需的確切上下文。

💻 本地開發

1. 克隆並安裝：

git clone https://github.com/mikhae1/kubeview-mcp.git
cd kubeview-mcp
npm install

2. 構建並運行：

npm run build
npm start

3. 測試：

npm test

CLI使用方法

你可以通過CLI直接測試工具：

npm run command -- kube_list --namespace=default

📄 許可證

本項目採用MIT許可證，版權歸 mikhae1 所有。