article
README
🚀 KubeBlocks 云 MCP 服务器
KubeBlocks 云 MCP 服务器基于 模型上下文协议 (MCP) 构建,能与 KubeBlocks 云 API 实现无缝集成。借助该服务器,AI 助手可通过标准化工具调用接口,与 KubeBlocks 云资源进行交互。
🚀 快速开始
KubeBlocks 云 MCP 服务器允许 AI 助手与 KubeBlocks 云资源交互,以下是使用前的准备和操作步骤。
✨ 主要特性
- MCP 驱动的 API:基于 MCP 的 API,可用于访问 KubeBlocks 云资源。
- 安全认证机制:通过 KubeBlocks 云 API 密钥和秘密实现安全身份验证。
- 丰富资源支持:支持常见的 KubeBlocks 云资源,如组织、环境、实例和备份。
- 语言翻译功能:提供语言翻译功能(目前支持中文)。
- 完善技术支持:提供完整的文档和技术支持。
📦 安装指南
从源代码安装
# 克隆仓库
git clone https://github.com/apecloud/kb-cloud-mcp-server.git
cd kb-cloud-mcp-server
# 安装依赖
glide install
# 编译并运行
go build && ./kb-mcp-server
使用 Docker 安装
# 拉取镜像
docker pull apecloud/kb-cloud-mcp-server:latest
# 运行容器
docker run -it --rm apecloud/kb-cloud-mcp-server:latest
📚 详细文档
先决条件
- 具备基础的 Go 语言编程知识。
- 对 KubeBlocks 云平台有基本了解。
- 安装了 Git 和依赖管理工具 (如 Glide)。
配置方法
环境变量配置
KB_API_KEY:KubeBlocks 云 API 访问密钥。KB_API_SECRET:KubeBlocks 云 API 秘密密钥。KB_ENDPOINT:KubeBlocks 云 API 终端点地址。PORT:MCP 服务器监听的端口,默认为 8080。
配置文件示例
{
"api_key": "your_api_key",
"api_secret": "your_api_secret",
"endpoint": "https://api.kubecloud.com/v1",
"port": 8080,
"log_level": "info"
}
图书馆使用
此模块导出的 Go API 目前应被视为不稳定,并可能引起重大变化。未来可能会提供稳定性;如果有用例,请提交问题。
📄 许可证
本项目根据 Apache 2.0 许可证授权,具体条款见 LICENSE 文件。
微信扫一扫