Rancher MCP Server
使用说明内容(Markdown格式)
项目简介
- 这是一个实现 MCP(Model Context Protocol)的服务端,面向与 LLM 的集成场景,提供对 Rancher 多集群环境的资源、工具与 Prompt 模板的统一访问接口,并通过 JSON-RPC 与客户端通信,支持多种传输方式(stdio、HTTP/SSE 等)。
主要功能点
- 资源管理与数据访问:提供对 Kubernetes/Rancher 资源(集群、命名空间、节点、工作负载、服务、配置映射、秘钥、 ingress 等)的统一访问接口,输出支持 JSON、YAML、表格等格式。
- 工具注册与执行:将 Toolset 中的各类工具注册到 MCP 服务器,并暴露统一的调用入口,LLM 可通过工具执行 Rancher/Kubernetes 相关任务。
- Prompt 模板与上下文:支持 Prompts 的渲染与上下文注入,方便在对话中向 LLM 提供上下文信息。
- 安全与可扩展性:支持只读模式、禁用破坏性操作等安全特性,具备多 Toolset 的开关控制、日志分级等能力;服务端可扩展以接入更多传输协议(SSE、WebSocket 等)和后端资源。
- 传输与接口: MCP 服务器通过 JSON-RPC 进行请求/响应,内置 stdio 模式(适用于本地集成测试和嵌入式客户端)以及 HTTP/SSE/流式模式(网络访问)。
安装与运行步骤
- 编译与运行
- 在本地开发环境中,使用推荐的构建方式编译服务器源码后直接运行,或下载最新发行版二进制进行部署。
- 运行后服务器会根据配置文件/命令行参数自动选择 stdio 模式或 HTTP/SSE 模式。
- 安装依赖与构建(简要)
- 使用 Go 语言环境构建源码,或使用提供的 Docker/npm 分发包进行部署。
- 服务器自身会与 Rancher API 进行交互,需提供 Rancher 服务地址、Token/Access Key 与密钥等凭证。
服务器配置(MCP 客户端视角的示例配置) 说明:MCP 客户端需要在其配置中指定 MCP 服务器的启动命令及参数,以便建立连接。下列 JSON 示例描述了常见的两种配置场景:
-
使用 npx 启动的方式(来自仓库示例说明) { "serverName": "rancher", "command": "npx", "args": [ "-y", "@futuretea/rancher-mcp-server@latest", "--rancher-server-url", "https://your-rancher-server.com/v3", "--rancher-token", "your-token" ] } 注释:该配置通过 npx 下载并运行最新版本的 rancher-mcp-server,连接到指定的 Rancher 服务端地址,使用提供的 token 进行认证。
-
使用本地二进制直接启动(推荐在生产环境使用二进制部署) { "serverName": "rancher", "command": "./rancher-mcp-server", "args": [ "--port", "8080", "--rancher-server-url", "https://your-rancher-server.com/v3", "--rancher-token", "your-token" ] } 注释:该配置直接执行本地编译或下载的 rancher-mcp-server 二进制,监听 HTTP/SSE 端口 8080,连接 Rancher 服务端并使用提供的凭证进行认证。
基本使用方法
- 启动方式
- 使用 npm/npx 方式快速试用:npx @futuretea/rancher-mcp-server@latest --rancher-server-url https://your-rancher-server.com/v3 --rancher-token your-token
- 使用本地二进制方式部署:./rancher-mcp-server --port 8080 --rancher-server-url https://your-rancher-server.com/v3 --rancher-token your-token
- 接入 MCP 客户端
- 将上述配置写入 MCP 客户端的配置文件中(如 Claude Desktop、VS Code 以及 Cursor 插件的 mcpServers 配置段),确保服务器名称、启动命令和参数正确指向 Rancher 服务地址与权限信息。
- 启动 MCP 客户端后,LLM 客户端即可通过 MCP 服务器提供的资源、工具、Prompts 等进行对话驱动的推理和操作。
使用要点
- 安全性:可以开启只读模式和禁用破坏性操作,保护 Rancher 集群不被意外修改。
- 输出格式:资源查询和工具结果支持 JSON、YAML、table 三种输出,便于不同场景下的解析和展示。
- 扩展性:工具集分为 config、core、rancher、networking 等,便于按需开启或禁用,提升上下文的可控性和效率。