article
README
🚀 Kubernetes MCP 服务器
Kubernetes MCP 服务器是一个后端系统,它提供了交互式且可扩展的接口,用于管理 Kubernetes 资源、检索和分析日志,还能通过模型上下文协议 (MCP) 格式化日志以便导出。
🚀 快速开始
Kubernetes MCP 服务器能够帮助你高效管理 Kubernetes 资源和处理日志。在使用前,请确保满足以下要求:
- Go 1.24+ 版本
- 具备 Kubernetes 集群访问权限
- 完成 kubectl 工具的配置
✨ 主要特性
- 可对 Kubernetes 资源(如 Pod、服务、命名空间、部署等)执行 CRUD 操作。
- 支持日志检索和模式搜索。
- 能将日志格式化为多种格式(纯文本、JSON、CSV、NDJSON)并导出。
- 拥有可扩展的架构,便于未来进行功能增强。
📦 安装指南
按照以下步骤安装 Kubernetes MCP 服务器:
# 克隆仓库
git clone https://github.com/mayukhsarkar/k8s-mcp-server.git
cd k8s-mcp-server
# 构建二进制文件
go build -o k8s-mcp-server
# 启动服务器
./k8s-mcp-server serve
💻 使用示例
基础用法
# 启动 MCP 服务器
./k8s-mcp-server serve
# 获取帮助信息
./k8s-mcp-server --help
📚 详细文档
MCP 服务器暴露了 HTTP 端点,用于与 Kubernetes 资源和日志进行交互,具体如下:
Kubernetes 操作
POST /api/v1/resources/{resource_type}- 创建资源GET /api/v1/resources/{resource_type}- 列出资源GET /api/v1/resources/{resource_type}/{name}- 获取资源详情DELETE /api/v1/resources/{resource_type}/{name}- 删除资源
日志操作
GET /api/v1/logs/{namespace}/{pod}- 获取 pod 日志GET /api/v1/logs/search- 搜索日志中的模式匹配GET /api/v1/logs/export- 导出多种格式的日志
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫