Overview
What is KubeBlocks Cloud MCP Server?
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.
How to use KubeBlocks Cloud MCP Server?
Install by building from source (Go 1.20+) or using the Docker image. Set the required environment variables KB_CLOUD_API_KEY_NAME and KB_CLOUD_API_KEY_SECRET, then start the server with ./kb-cloud-mcp-server. Optionally, configure via command-line flags or a YAML configuration file. Use in VS Code by adding the provided JSON block to user or workspace settings.
Key features of KubeBlocks Cloud MCP Server
- MCP-based API for accessing KubeBlocks Cloud resources
- Secure authentication via KubeBlocks Cloud API key and secret
- Support for Organizations, Environments, Instances, and Backups
- Internationalization support via translation helpers
- Configurable logging levels and debug mode
- Deployable from source or as a Docker container
Use cases of KubeBlocks Cloud MCP Server
- 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
FAQ from KubeBlocks Cloud MCP Server
What are the prerequisites?
Go 1.20+ and KubeBlocks Cloud API credentials (an API key name and secret) are required.
How do I authenticate with KubeBlocks Cloud?
Set the environment variables KB_CLOUD_API_KEY_NAME and KB_CLOUD_API_KEY_SECRET, or provide them via command-line flags (--api-key, --api-secret) or in a YAML configuration file.
What resources can I manage with the MCP tools?
You can list and get details for Organizations, Environments, Instances, and Backups. The exact tools are: list_organizations, get_organization, list_environments, get_environment, list_instances, get_instance, list_backups, and get_backup.
What transport does the server use?
The server uses StdioServer for secure communication.
Is there a configuration file option?
Yes, you can use a YAML file (e.g., .kb-cloud-mcp-server.yaml) to set log level, API key, secret, and site URL, then start with --config=.kb-cloud-mcp-server.yaml.
