Kb Cloud MCP Server

🚀 KubeBlocks Cloud MCP Server

The KubeBlocks Cloud MCP Server is a server based on the Model Context Protocol (MCP), which can be smoothly integrated with the KubeBlocks Cloud API. It enables AI assistants to interact with KubeBlocks Cloud resources through standardized tool call interfaces.

🚀 Quick Start

The KubeBlocks Cloud MCP Server provides a standardized way for AI assistants to interact with KubeBlocks Cloud resources. Below are the details about its usage scenarios, features, installation, configuration, etc.

✨ Features

• MCP-based API: It offers an API based on MCP for accessing KubeBlocks Cloud resources.
• Secure Authentication: Achieves secure authentication through KubeBlocks Cloud API keys and secrets.
• Resource Support: Supports common KubeBlocks Cloud resources, including organizations, environments, instances, and backups.
• Language Translation: Provides language translation functionality (currently supports Chinese).
• Documentation and Support: Offers comprehensive documentation and technical support.

📦 Installation

Prerequisites

• Basic knowledge of Go programming.
• A fundamental understanding of the KubeBlocks Cloud platform.
• Git and a dependency management tool (e.g., Glide) installed.

Installation from Source Code

1. Clone the repository:

git clone https://github.com/apecloud/kb-cloud-mcp-server.git
cd kb-cloud-mcp-server

2. Install dependencies:

glide install

3. Compile and run:

go build && ./kb-mcp-server

Installation Using Docker

1. Pull the image:

docker pull apecloud/kb-cloud-mcp-server:latest

2. Run the container:

docker run -it --rm apecloud/kb-cloud-mcp-server:latest

📚 Documentation

Configuration Methods

Environment Variable Configuration

Here are some commonly used environment variables:

• KB_API_KEY: KubeBlocks Cloud API access key.
• KB_API_SECRET: KubeBlocks Cloud API secret key.
• KB_ENDPOINT: KubeBlocks Cloud API endpoint address.
• PORT: The port that the MCP server listens on, with a default value of 8080.

Configuration File Example

{
  "api_key": "your_api_key",
  "api_secret": "your_api_secret",
  "endpoint": "https://api.kubecloud.com/v1",
  "port": 8080,
  "log_level": "info"
}

Library Usage

The Go API exported by this module should currently be considered unstable and may undergo significant changes. Stability may be provided in the future; if you have use cases, please submit an issue.

📄 License

This project is licensed under the Apache 2.0 license. For specific terms, see the LICENSE file.