article
README
🚀 k8s-mcp
一个基于 Python 的只读 Kubernetes 集群 模型上下文协议 (MCP) 服务器,它提供了全面的 API 来检索集群信息并诊断问题,为您的 Kubernetes 集群管理提供便利。
🚀 快速开始
安装
先决条件
- Python 3.8+
- 对 Kubernetes 集群的访问权限(通过 kubeconfig 或 in-cluster 配置)
- 必要的 Python 包(请参见
pyproject.toml中的dependencies)
# 安装 uv
curl -LsSf https://astral.sh/uv/install.sh | sh
# 克隆仓库
git clone git@github.com:vlttnv/k8s-mcp.git
cd k8s-mcp
# 安装依赖项
uv venv
source .venv/bin/activate
uv sync
如果使用 Claude,请配置您的桌面应用设置。在 ~/Library/Application Support/Claude/claude_desktop_config.json 中打开以文本编辑器查看:
code ~/Library/Application\ Support/Claude/claude_desktop_config.json
{
"mcpServers": {
"k8s-mcp": {
"command": "uv",
"args": [
"--directory",
"/ABSOLUTE/PATH/TO/PARENT/FOLDER/k8s-mcp",
"run",
"server.py"
]
}
}
}
⚠️ 重要提示
如果需要,您可能需要在 command 字段中指定 uv 可执行文件的完整路径。您可以通过运行
which uv(macOS/Linux)或where uv(Windows)来获取。
配置
应用程序自动尝试两种方法连接到您的 Kubernetes 集群:
- Kubeconfig 文件:使用本地 kubeconfig 文件(通常位于
~/.kube/config) - In-Cluster Configuration:如果在 Kubernetes pod 中运行,则使用服务账户令牌
如果您的 kubeconfig 设置正确或您在集群内部运行且具有适当的 RBAC 权限,则无需额外配置。
使用说明
安装步骤
- 克隆仓库并进入目录。
- 使用 uv 工具创建虚拟环境并激活。
- 同步依赖项后启动服务。
示例查询
# 基本命令示例
uv run server.py
📄 许可证
✨ 贡献
欢迎贡献!请随时提交 Pull Request。
微信扫一扫