Mkp

🚀 MKP 項目文檔（中文版）

MKP 是一款用於與 Kubernetes 集群交互的工具。它藉助模型上下文協議 (MCP) 提供資源訪問和服務，具備資源發現、操作和配置管理等一系列實用功能。

🚀 快速開始

MKP 工具能幫助你方便地與 Kubernetes 集群進行交互，通過 MCP 協議實現資源的訪問與管理。下面將為你介紹其安裝、運行及使用方法。

📦 安裝指南

快速安裝

克隆倉庫並進行構建：

# 克隆倉庫並構建
git clone https://github.com/StacklokLabs/mkp.git
cd mkp
make build

運行服務器

以下是不同參數下運行服務器的示例：

# 默認運行
./build/mkp-server

# 指定 kubeconfig 文件
./build/mkp-server --kubeconfig=/path/to/kubeconfig

# 以只讀模式運行（默認）
./build/mkp-server --read-only=true

# 禁用資源發現
./build/mkp-server --serve-resources=false

💻 使用示例

基礎用法

MCP 工具 - 資源操作工具

獲取資源信息

# 示例命令
echo '{
  "id": "get_resource",
  "method": "GET",
  "params": {
    "uri": "k8s://clustered/apps/v1/deployments/nginx-deployment"
  }
}' | ./build/mkp-server --tool stdout

列舉資源

# 示例命令
echo '{
  "id": "list_resources",
  "method": "GET",
  "params": {
    "uri": "k8s://clustered/apps/v1/deployments"
  }
}' | ./build/mkp-server --tool stdout

應用資源配置

# 示例命令
echo '{
  "id": "apply_resource", 
  "method": "POST",
  "params": {
    "uri": "k8s://namespaced/default/apps/v1/deployments/nginx-deployment",
    "manifest": {
      "apiVersion": "apps/v1",
      "kind": "Deployment",
      "metadata": {
        "name": "nginx-deployment",
        "namespace": "default"
      },
      "spec": {
        "replicas": 3,
        "selector": {
          "matchLabels": {
            "app": "nginx"
          }
        },
        "template": {
          "metadata": {
            "labels": {
              "app": "nginx"
            }
          },
          "spec": {
            "containers": [
              {
                "name": "nginx",
                "image": "nginx:latest",
                "ports": [80]
              }
            ]
          }
        }
      }
    }
  }
}' | ./build/mkp-server --tool stdout

高級用法

與 ToolHive 集成

運行實例

# 啟動 MCP 服務器
./build/mkp-server --tool stdout

# 使用 ToolHive 部署
poetry run mcp run \
    --name mkp-service \
    --image ./build/mkp-server \
    --command "mkp-server" \
    --port 8080

驗證實例

poetry run mcp ls

停止實例

poetry run mcp stop mkp-service

📚 詳細文檔

資源發現與服務模式

配置選項

• 資源發現：可通過 --serve-resources 參數控制是否啟用資源發現功能。
• 服務模式：默認為只讀模式，可使用 --read-only 或 --read-write 設置讀寫權限。

開發信息

代碼測試

make test

格式化代碼

make fmt

管理依賴

go mod tidy

📄 許可證

項目使用 MIT 許可證，具體內容請參見 LICENSE 文件。