使用说明
项目简介
Kopilot-MCP Server 是一个基于 Model Context Protocol (MCP) 构建的 Kubernetes AI Agent。它允许用户使用自然语言与 Kubernetes 集群进行交互,并执行资源管理操作。通过 MCP 协议,Kopilot-MCP Server 提供了一套标准化的接口,使得 LLM 客户端能够安全、可扩展地访问 Kubernetes 上下文信息和功能。
主要功能点
- 自然语言操作 Kubernetes 资源:用户可以使用自然语言查询和命令,例如“获取 kube-system 命名空间下的 Pod”或“创建一个 Nginx Deployment”。
- MCP 标准化工具调用:通过 MCP 协议注册和执行工具,实现与 Kubernetes 集群的交互,并支持工具的发现和调用。
- 可定制 LLM 提供商:可以配置不同的 LLM 提供商(如 OpenAI、OpenRouter 等)来处理自然语言请求,并执行相应的 Kubernetes 操作。
- 学习 MCP 的实践案例:提供了一个实际的 MCP 服务器应用示例,帮助开发者理解和学习如何使用 MCP 构建上下文服务。
安装步骤
- 克隆仓库
git clone https://github.com/KokoiRuby/Kopilot-MCP cd Kopilot-MCP - 配置
复制 'config/dev/example.toml' 文件并重命名为 'config/dev/config.toml',根据您的 Kubernetes 集群和 LLM API 密钥修改配置文件。
需要配置的信息包括:
- Kubernetes 集群的 kubeconfig 文件路径。
- LLM 提供商的 API 密钥和模型设置 (例如 OpenAI API Key)。
- 安装依赖
确保您已安装 Python 3.12+ 和 uv。然后运行以下命令安装项目依赖:
uv sync
服务器配置
MCP 客户端需要配置以下 JSON 格式信息以连接到 Kopilot-MCP Server:
{ "server name": "Kopilot-MCP Server", "command": "/usr/local/bin/python3", // MCP 服务器启动命令,请根据您的 Python 实际安装路径进行配置 "args": ["./mcp_server.py"] // MCP 服务器启动参数,指定运行 mcp_server.py 文件 }
请注意:以上配置信息为 JSON 格式,MCP 客户端会读取这些配置来启动和连接 MCP 服务器。您无需手动执行 'mcp_server.py',客户端会自动处理服务器的启动。
基本使用方法
- 启动客户端
在仓库根目录下,运行 MCP 客户端脚本 'mcp_client.py':
客户端启动后,会自动启动并连接 MCP 服务器。uv run mcp_client.py - 输入查询
在终端中会显示 'Query (Type 'exit', 'quit', 'q' to quit):' 提示符,在此处输入自然语言查询,例如:
Get pods in kube-system namespace - 查看结果 Kopilot-MCP Server 会解析您的查询,调用相应的 Kubernetes 工具,并将结果返回到终端。
信息
分类
开发者工具