MKP 项目文档（中文版）

项目简介

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

资源发现与服务模式

配置选项

• 资源发现：通过 --serve-resources 参数控制是否启用资源发现功能。
• 服务模式：默认为只读模式，可使用 --read-only 或 --read-write 设置读写权限。

开发信息

代码测试

make test

格式化代码

make fmt

管理依赖

go mod tidy

与 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

许可证

项目使用 MIT 许可证，具体内容请参见 LICENSE 文件。