K8s MCP Server

🚀 K8s MCP Server

本項目是一個用於 Kubernetes 操作的模型控制協議（MCP）服務器。它提供了管理部署、Pod、服務等的工具。

🚀 快速開始

✨ 主要特性

• 提供用於管理 Kubernetes 部署、Pod、服務等的工具。
• 支持直接運行和使用 Docker 容器化部署兩種方式。
• 可與 GitHub Copilot 和 Claude Desktop 等 MCP 客戶端集成，提供代碼建議和補全功能。

📦 安裝指南

前提條件

• Python 3.12 或更高版本
• uv 包管理器
• Minikube（用於本地 Kubernetes 開發）
• Docker（可選，用於容器化部署）

運行 MCP 服務器

主要方法：直接運行

1. 創建虛擬環境：

uv venv .venv

2. 激活虛擬環境：
   • 在 macOS/Linux 上：

source .venv/bin/activate

- 在 Windows 上：

.venv\Scripts\activate

3. 安裝依賴項：

uv pip install -e .

4. 運行服務器：

python src/main.py

替代方法：使用 Docker（可選）

1. 拉取 Docker 鏡像：

docker pull chinnareddy578/k8s-mcp-server

2. 運行 Docker 容器：

docker run -it \
  -v ${HOME}/.kube:/root/.kube:ro \
  -v ${HOME}/.minikube:/root/.minikube:ro \
  chinnareddy578/k8s-mcp-server

💻 使用示例

使用 MCP 服務器與 MCP 客戶端

GitHub Copilot

1. 配置 GitHub Copilot：
   • 打開你的 GitHub Copilot 設置。
   • 添加以下配置：

{
    "servers": {
        "k8s-mcp-server": {
            "command": "python",
            "args": [
                "src/main.py"
            ]
        }
    }
}

或者，如果你更喜歡使用 Docker：

{
    "servers": {
        "k8s-mcp-server": {
            "command": "docker",
            "args": [
                "run",
                "-i",
                "--rm",
                "--init",
                "-e", "PYTHONUNBUFFERED=1",
                "-v", "${HOME}/.kube:/root/.kube:ro",
                "-v", "${HOME}/.minikube:/root/.minikube:ro",
                "chinnareddy578/k8s-mcp-server"
            ]
        }
    }
}

2. 使用 GitHub Copilot：
   • GitHub Copilot 現在將使用 MCP 服務器進行代碼建議和補全。

Claude Desktop

1. 配置 Claude Desktop：
   • 打開 Claude Desktop 設置。
   • 添加以下配置：

{
    "mcpServers": {
        "k8s-mcp-server": {
            "command": "python",
            "args": [
                "src/main.py"
            ]
        }
    }
}

或者，如果你更喜歡使用 Docker：

{
    "mcpServers": {
        "k8s-mcp-server": {
            "command": "docker",
            "args": [
                "run",
                "-i",
                "--rm",
                "--init",
                "-e", "PYTHONUNBUFFERED=1",
                "-v", "${HOME}/.kube:/root/.kube:ro",
                "-v", "${HOME}/.minikube:/root/.minikube:ro",
                "chinnareddy578/k8s-mcp-server"
            ]
        }
    }
}

2. 使用 Claude Desktop：
   • Claude Desktop 現在將使用 MCP 服務器進行代碼建議和補全。

🔧 技術細節

故障排除

• Kubernetes 配置：確保 Minikube 正在運行，並且你的 kubeconfig 已正確設置：

minikube status
minikube kubectl -- get pods

• 連接問題：如果使用 Docker，請確保容器正在運行，並且可以訪問你的 Kubernetes 配置：

docker ps

• 工具未找到：驗證該工具已在你的 MCP 服務器中註冊，並且名稱完全匹配。

📄 許可證

本項目採用 MIT 許可證 - 有關詳細信息，請參閱 LICENSE 文件。