{"id":29113503,"url":"https://github.com/apecloud/kb-cloud-mcp-server","last_synced_at":"2026-03-16T11:37:38.590Z","repository":{"id":287135173,"uuid":"963608807","full_name":"apecloud/kb-cloud-mcp-server","owner":"apecloud","description":"MCP server for KubeBlocks Cloud","archived":false,"fork":false,"pushed_at":"2025-04-10T05:34:33.000Z","size":60,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-10T06:34:21.146Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apecloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-04-10T00:07:47.000Z","updated_at":"2025-04-10T05:33:23.000Z","dependencies_parsed_at":"2025-04-10T06:34:30.466Z","dependency_job_id":null,"html_url":"https://github.com/apecloud/kb-cloud-mcp-server","commit_stats":null,"previous_names":["apecloud/kb-cloud-mcp-server"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/apecloud/kb-cloud-mcp-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apecloud%2Fkb-cloud-mcp-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apecloud%2Fkb-cloud-mcp-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apecloud%2Fkb-cloud-mcp-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apecloud%2Fkb-cloud-mcp-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apecloud","download_url":"https://codeload.github.com/apecloud/kb-cloud-mcp-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apecloud%2Fkb-cloud-mcp-server/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262581371,"owners_count":23331913,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-29T11:05:36.062Z","updated_at":"2025-10-25T08:01:17.753Z","avatar_url":"https://github.com/apecloud.png","language":"Go","funding_links":[],"categories":["⚙️ DevOps","Cloud Platforms"],"sub_categories":["How to Submit"],"readme":"# KubeBlocks Cloud MCP Server\n\nThe KubeBlocks Cloud MCP Server is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction)\nserver that provides seamless integration with KubeBlocks Cloud APIs, enabling AI assistants to interact with\nKubeBlocks Cloud resources through a standardized tool-calling interface.\n\n[![Go Version](https://img.shields.io/github/go-mod/go-version/apecloud/kb-cloud-mcp-server?style=flat-square)](https://go.mod)\n[![License](https://img.shields.io/github/license/apecloud/kb-cloud-mcp-server?style=flat-square)](LICENSE)\n\n## Use Cases\n\n- Automating KubeBlocks Cloud resource management\n- Retrieving and analyzing data from KubeBlocks Cloud environments\n- Building AI-powered tools that interact with the KubeBlocks Cloud ecosystem\n- Enabling AI assistants to provision and manage database instances\n\n## Features\n\n- MCP-based API for accessing KubeBlocks Cloud resources\n- Secure authentication via KubeBlocks Cloud API key and secret\n- Support for common KubeBlocks Cloud resources:\n  - Organizations\n  - Environments\n  - Instances\n  - Backups\n- Internationalization support via translation helpers\n- Secure communication through StdioServer\n\n## Prerequisites\n\n1. Go 1.20+ (compatible with the MCP-Go package)\n2. KubeBlocks Cloud API credentials - you'll need an API key name and secret\n\n## Installation\n\n### Build from Source\n\n```bash\ngit clone https://github.com/apecloud/kb-cloud-mcp-server.git\ncd kb-cloud-mcp-server\ngo mod tidy\ngo build -o kb-cloud-mcp-server ./cmd/server\n```\n\n### Usage with VS Code\n\nAdd 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)`.\n\nOptionally, you can add it to a file called `.vscode/mcp.json` in your workspace to share the configuration with others.\n\n\u003e Note that the `mcp` key is not needed in the `.vscode/mcp.json` file.\n\n```json\n{\n  \"mcp\": {\n    \"inputs\": [\n      {\n        \"type\": \"promptString\",\n        \"id\": \"kb_cloud_api_key\",\n        \"description\": \"KubeBlocks Cloud API Key Name\",\n        \"password\": false\n      },\n      {\n        \"type\": \"promptString\",\n        \"id\": \"kb_cloud_api_secret\",\n        \"description\": \"KubeBlocks Cloud API Secret\",\n        \"password\": true\n      }\n    ],\n    \"servers\": {\n      \"kbcloud\": {\n        \"command\": \"docker\",\n        \"args\": [\n          \"run\",\n          \"-i\",\n          \"--rm\",\n          \"-e\",\n          \"KB_CLOUD_API_KEY_NAME\",\n          \"-e\",\n          \"KB_CLOUD_API_KEY_SECRET\",\n          \"apecloud/kb-cloud-mcp-server:latest\"\n        ],\n        \"env\": {\n          \"KB_CLOUD_API_KEY_NAME\": \"${input:kb_cloud_api_key}\",\n          \"KB_CLOUD_API_KEY_SECRET\": \"${input:kb_cloud_api_secret}\"\n        }\n      }\n    }\n  }\n}\n```\n\nMore about using MCP server tools in VS Code's [agent mode documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).\n\n## Usage\n\n### Environment Variables\n\nThe server supports the following environment variables:\n\n```bash\n# KubeBlocks Cloud API credentials (required)\nexport KB_CLOUD_API_KEY_NAME=your-api-key-name\nexport KB_CLOUD_API_KEY_SECRET=your-api-key-secret\nexport KB_CLOUD_SITE=https://api.apecloud.com  # Optional: KubeBlocks Cloud API endpoint\n\n# Server configuration\nexport KB_CLOUD_MCP_LOG_LEVEL=info  # debug, info, warn, error\nexport KB_CLOUD_MCP_EXPORT_TRANSLATIONS=true  # Optional: Export translations to JSON file\nexport KB_CLOUD_DEBUG=true  # Optional: Enable debug mode for KubeBlocks Cloud API client\n```\n\n### Starting the Server\n\n```bash\n./kb-cloud-mcp-server\n```\n\nOr with command-line flags:\n\n```bash\n./kb-cloud-mcp-server stdio --api-key=your-api-key-name --api-secret=your-api-key-secret\n```\n\n### Configuration File\n\nYou can also use a configuration file:\n\n```yaml\n# .kb-cloud-mcp-server.yaml\nlog_level: info\napi_key: your-api-key-name\napi_secret: your-api-key-secret\nsite_url: https://api.apecloud.com\n```\n\nThen start the server with:\n\n```bash\n./kb-cloud-mcp-server stdio --config=.kb-cloud-mcp-server.yaml\n```\n\n## Available MCP Tools\n\nThe server provides the following MCP tools for interacting with KubeBlocks Cloud resources:\n\n### Organizations\n\n- **list_organizations** - List all organizations you have access to\n  - No parameters required\n\n- **get_organization** - Get details of a specific organization\n  - `organizationId`: Organization unique identifier (string, required)\n\n### Environments\n\n- **list_environments** - List all environments within an organization\n  - `organizationId`: Organization unique identifier (string, required)\n\n- **get_environment** - Get details of a specific environment\n  - `organizationId`: Organization unique identifier (string, required)\n  - `environmentId`: Environment unique identifier (string, required)\n\n### Instances\n\n- **list_instances** - List all instances within an environment\n  - `organizationId`: Organization unique identifier (string, required)\n  - `environmentId`: Environment unique identifier (string, required)\n\n- **get_instance** - Get details of a specific instance\n  - `organizationId`: Organization unique identifier (string, required)\n  - `environmentId`: Environment unique identifier (string, required)\n  - `instanceId`: Instance unique identifier (string, required)\n\n### Backups\n\n- **list_backups** - List all backups for an instance\n  - `organizationId`: Organization unique identifier (string, required)\n  - `environmentId`: Environment unique identifier (string, required)\n  - `instanceId`: Instance unique identifier (string, required)\n\n- **get_backup** - Get details of a specific backup\n  - `organizationId`: Organization unique identifier (string, required)\n  - `environmentId`: Environment unique identifier (string, required)\n  - `instanceId`: Instance unique identifier (string, required)\n  - `backupId`: Backup unique identifier (string, required)\n\n## Library Usage\n\nThe 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.\n\n## License\n\nThis project is licensed under the Apache 2.0 License - see the [LICENSE](./LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapecloud%2Fkb-cloud-mcp-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapecloud%2Fkb-cloud-mcp-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapecloud%2Fkb-cloud-mcp-server/lists"}