KubeBlocks Cloud

by apecloud

2 134 downloads Not rated yet MIT
GitHub

About

Enables querying and managing KubeBlocks Cloud resources including organizations, environments, instances, and backups via the KB Cloud API for automated database operations.

Details

Repository
apecloud/kb-cloud-mcp-server
License
MIT

Explore

- MCP-based API for accessing KubeBlocks Cloud resources
- Secure authentication via KubeBlocks Cloud API key and secret
- Support for common KubeBlocks Cloud resources:
- Organizations
- Environments
- Instances
- Backups
- Internationalization support via translation helpers
- Secure communication through StdioServer

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name KubeBlocks Cloud
    Command (node, npx, python, etc.) docker
    Arguments
    • Argument 1 run
    • Argument 2 -i
    • Argument 3 --rm
    • Argument 4 -e
    • Argument 5 KB_CLOUD_API_KEY_NAME
    • Argument 6 -e
    • Argument 7 KB_CLOUD_API_KEY_SECRET
    • Argument 8 apecloud/kb-cloud-mcp-server:latest
    Environment
    • KB_CLOUD_API_KEY_NAME $${input:kb_cloud_api_key}
    • KB_CLOUD_API_KEY_SECRET $${input:kb_cloud_api_secret}

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

1. Go 1.20+ (compatible with the MCP-Go package)
2. KubeBlocks Cloud API credentials - you'll need an API key name and secret

Add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing Ctrl + Shift + P and typing Preferences: Open User Settings (JSON).

Optionally, you can add it to a file called .vscode/mcp.json in your workspace to share the configuration with others.

> Note that the mcp key is not needed in the .vscode/mcp.json file.

{
  "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}"
        }
      }
    }
  }
}

More about using MCP server tools in VS Code's agent mode documentation.

The server supports the following environment variables:


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

You can also use a configuration file:

``yaml

- list_environments - List all environments within an organization
- organizationId: Organization unique identifier (string, required)

- get_environment - Get details of a specific environment
- organizationId: Organization unique identifier (string, required)
- environmentId`: Environment unique identifier (string, required)

The exported Go API of this module should currently be considered unstable and subject to breaking changes. In the future, we may offer stability; please file an issue if there is a use case where this would be valuable.

list_organizations

List all organizations you have access to. No parameters required.

get_organization

Get details of a specific organization. Parameters: organizationId (string, required)

list_environments

List all environments within an organization. Parameters: organizationId (string, required)

get_environment

Get details of a specific environment. Parameters: organizationId (string, required), environmentId (string, required)

list_instances

List all instances within an environment. Parameters: organizationId (string, required), environmentId (string, required)

get_instance

Get details of a specific instance. Parameters: organizationId (string, required), environmentId (string, required), instanceId (string, required)

list_backups

List all backups for an instance. Parameters: organizationId (string, required), environmentId (string, required), instanceId (string, required)

get_backup

Get details of a specific backup. Parameters: organizationId (string, required), environmentId (string, required), instanceId (string, required), backupId (string, required)

The server provides the following MCP tools for interacting with KubeBlocks Cloud resources:

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "kubeblocks cloud": {
            "env": {
                "KB_CLOUD_API_KEY_NAME": "$${input:kb_cloud_api_key}",
                "KB_CLOUD_API_KEY_SECRET": "$${input:kb_cloud_api_secret}"
            },
            "args": [
                "run",
                "-i",
                "--rm",
                "-e",
                "KB_CLOUD_API_KEY_NAME",
                "-e",
                "KB_CLOUD_API_KEY_SECRET",
                "apecloud/kb-cloud-mcp-server:latest"
            ],
            "command": "docker"
        }
    }
}

Linux

{
    "env": {
        "KB_CLOUD_API_KEY_NAME": "$${input:kb_cloud_api_key}",
        "KB_CLOUD_API_KEY_SECRET": "$${input:kb_cloud_api_secret}"
    },
    "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "KB_CLOUD_API_KEY_NAME",
        "-e",
        "KB_CLOUD_API_KEY_SECRET",
        "apecloud/kb-cloud-mcp-server:latest"
    ],
    "command": "docker"
}

Macos

{
    "env": {
        "KB_CLOUD_API_KEY_NAME": "$${input:kb_cloud_api_key}",
        "KB_CLOUD_API_KEY_SECRET": "$${input:kb_cloud_api_secret}"
    },
    "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "KB_CLOUD_API_KEY_NAME",
        "-e",
        "KB_CLOUD_API_KEY_SECRET",
        "apecloud/kb-cloud-mcp-server:latest"
    ],
    "command": "docker"
}

Windows

{
    "env": {
        "KB_CLOUD_API_KEY_NAME": "$${input:kb_cloud_api_key}",
        "KB_CLOUD_API_KEY_SECRET": "$${input:kb_cloud_api_secret}"
    },
    "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "KB_CLOUD_API_KEY_NAME",
        "-e",
        "KB_CLOUD_API_KEY_SECRET",
        "apecloud/kb-cloud-mcp-server:latest"
    ],
    "command": "docker"
}

The KubeBlocks Cloud MCP Server is a Model Context Protocol (MCP)
server that provides seamless integration with KubeBlocks Cloud APIs, enabling AI assistants to interact with
KubeBlocks Cloud resources through a standardized tool-calling interface.

Go Version
License

Use Cases

- Automating KubeBlocks Cloud resource management
- Retrieving and analyzing data from KubeBlocks Cloud environments
- Building AI-powered tools that interact with the KubeBlocks Cloud ecosystem
- Enabling AI assistants to provision and manage database instances

Features

- MCP-based API for accessing KubeBlocks Cloud resources
- Secure authentication via KubeBlocks Cloud API key and secret
- Support for common KubeBlocks Cloud resources:
- Organizations
- Environments
- Instances
- Backups
- Internationalization support via translation helpers
- Secure communication through StdioServer

Prerequisites

1. Go 1.20+ (compatible with the MCP-Go package)
2. KubeBlocks Cloud API credentials - you'll need an API key name and secret

Installation

Build from Source

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

Usage with VS Code

Add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing Ctrl + Shift + P and typing Preferences: Open User Settings (JSON).

Optionally, you can add it to a file called .vscode/mcp.json in your workspace to share the configuration with others.

> Note that the mcp key is not needed in the .vscode/mcp.json file.

{
  "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}"
        }
      }
    }
  }
}

More about using MCP server tools in VS Code's agent mode documentation.

Usage

Environment Variables

The server supports the following environment variables:

```bash

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

More like this

Similar MCP servers you might find useful

Browse category

Time

A Model Context Protocol server that provides time and timezone conversion capabilities. It enables LLMs to get current time information and perform timezone…

— 88.2k 954.3k dl
Productivity

Sentry

Sentry MCP Server connects compatible AI clients with Sentry error monitoring, allowing models and agents to inspect issues and event data through Model…

— 88.1k 4.3k dl
Developer Tools

Github

GitHub MCP Server connects compatible AI clients with GitHub repositories, issues, and pull requests, allowing models and agents to read and act on project…

— 88.1k 9.9k dl
Developer Tools

Git

A Model Context Protocol (MCP) server that provides tools for LLMs to read, search, and manipulate Git repositories. It enables automated repository…

— 88.1k 954.3k dl
Developer Tools