KubeBlocks Cloud MCP Server

KubeBlocks Cloud MCP 服务

KubeBlocks Cloud MCP 服务是一个 Model Context Protocol (MCP) 服务，可与 KubeBlocks Cloud API 无缝集成，使 AI 助手能够通过标准化的工具调用接口与 KubeBlocks Cloud 资源交互。

使用场景

• 自动化管理 KubeBlocks Cloud 资源
• 从 KubeBlocks Cloud 环境中检索和分析数据
• 构建可与 KubeBlocks Cloud 生态系统交互的 AI 工具
• 使 AI 助手能够预配和管理数据库实例

功能

• 基于 MCP 的 API，用于访问 KubeBlocks Cloud 资源
• 通过 KubeBlocks Cloud API 密钥和密钥进行安全身份验证
• 支持常见的 KubeBlocks Cloud 资源：
  • 组织
  • 环境
  • 实例
  • 备份
• 通过翻译辅助工具支持国际化
• 通过 StdioServer 实现安全通信

前置条件

1. Go 1.20+（兼容 MCP-Go 软件包）
2. KubeBlocks Cloud API 凭据——需要 API 密钥名称和密钥

安装

从源代码构建

git clone https://github.com/apecloud/kb-cloud-mcp-server.git
cd kb-cloud-mcp-server
go mod tidy
go build -o kb-cloud-mcp-server ./cmd/server

在 VS Code 中使用

将以下 JSON 代码块添加到 VS Code 中的用户设置（JSON）文件。按下 Ctrl + Shift + P 并输入 Preferences: Open User Settings (JSON) 即可进行此操作。

你也可以将其添加到工作区中的 .vscode/mcp.json 文件，以便与他人共享配置。

注意，.vscode/mcp.json 文件中不需要 mcp 键。

{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "kb_cloud_api_key",
        "description": "KubeBlocks Cloud API Key Name",
        "password": false
      },
      {
        "type": "promptString",
        "id": "kb_cloud_api_secret",
        "description": "KubeBlocks Cloud API Secret",
        "password": true
      }
    ],
    "servers": {
      "kbcloud": {
        "command": "docker",
        "args": [
          "run",
          "-i",
          "--rm",
          "-e",
          "KB_CLOUD_API_KEY_NAME",
          "-e",
          "KB_CLOUD_API_KEY_SECRET",
          "apecloud/kb-cloud-mcp-server:latest"
        ],
        "env": {
          "KB_CLOUD_API_KEY_NAME": "${input:kb_cloud_api_key}",
          "KB_CLOUD_API_KEY_SECRET": "${input:kb_cloud_api_secret}"
        }
      }
    }
  }
}

有关在 VS Code 中使用 MCP 服务工具的更多信息，请参阅Agent 模式文档。

使用

环境变量

此服务支持以下环境变量：

# KubeBlocks Cloud API credentials (required)
export KB_CLOUD_API_KEY_NAME=your-api-key-name
export KB_CLOUD_API_KEY_SECRET=your-api-key-secret
export KB_CLOUD_SITE=https://api.apecloud.com  # Optional: KubeBlocks Cloud API endpoint

# Server configuration
export KB_CLOUD_MCP_LOG_LEVEL=info  # debug, info, warn, error
export KB_CLOUD_MCP_EXPORT_TRANSLATIONS=true  # Optional: Export translations to JSON file
export KB_CLOUD_DEBUG=true  # Optional: Enable debug mode for KubeBlocks Cloud API client

启动服务

./kb-cloud-mcp-server

也可以使用命令行标志：

./kb-cloud-mcp-server stdio --api-key=your-api-key-name --api-secret=your-api-key-secret

配置文件

你也可以使用配置文件：

# .kb-cloud-mcp-server.yaml
log_level: info
api_key: your-api-key-name
api_secret: your-api-key-secret
site_url: https://api.apecloud.com

然后使用以下命令启动服务：

./kb-cloud-mcp-server stdio --config=.kb-cloud-mcp-server.yaml

可用的 MCP 工具

此服务提供以下 MCP 工具，用于与 KubeBlocks Cloud 资源交互：

组织

• list_organizations - 列出你有权访问的所有组织

  • 无需参数

• get_organization - 获取特定组织的详细信息

  • organizationId：组织唯一标识符（字符串，必填）

环境

• list_environments - 列出某个组织中的所有环境

  • organizationId：组织唯一标识符（字符串，必填）

• get_environment - 获取特定环境的详细信息

  • organizationId：组织唯一标识符（字符串，必填）
  • environmentId：环境唯一标识符（字符串，必填）

实例

• list_instances - 列出某个环境中的所有实例

  • organizationId：组织唯一标识符（字符串，必填）
  • environmentId：环境唯一标识符（字符串，必填）

• get_instance - 获取特定实例的详细信息

  • organizationId：组织唯一标识符（字符串，必填）
  • environmentId：环境唯一标识符（字符串，必填）
  • instanceId：实例唯一标识符（字符串，必填）

备份

• list_backups - 列出实例的所有备份

  • organizationId：组织唯一标识符（字符串，必填）
  • environmentId：环境唯一标识符（字符串，必填）
  • instanceId：实例唯一标识符（字符串，必填）

• get_backup - 获取特定备份的详细信息

  • organizationId：组织唯一标识符（字符串，必填）
  • environmentId：环境唯一标识符（字符串，必填）
  • instanceId：实例唯一标识符（字符串，必填）
  • backupId：备份唯一标识符（字符串，必填）

库的使用

目前应将此模块导出的 Go API 视为不稳定，且可能发生不兼容变更。未来我们可能会提供稳定性保障；如果您有相关使用场景，请提交 issue。

许可证

本项目采用 Apache 2.0 许可证，详情请参阅 LICENSE 文件。