Overview
What is ClickHouse Cloud MCP Server?
This MCP server provides tools to interact with the ClickHouse Cloud API (v1), allowing management of organizations and services. It is intended for developers who need to automate ClickHouse Cloud operations through the Model Context Protocol.
How to use ClickHouse Cloud MCP Server?
Clone the repository, install dependencies with npm install, build with npm run build, then set the required environment variables (CLICKHOUSE_API_KEY_ID, CLICKHOUSE_API_SECRET, CLICKHOUSE_API_URL). Configure the server in your MCP client (e.g., Claude Desktop) by adding the compiled dist/index.js as a command with the environment variables.
Key features of ClickHouse Cloud MCP Server
- Exposes ClickHouse Cloud API endpoints via MCP tools.
- Authenticates using ClickHouse OpenAPI Key ID and Secret.
- Handles JSON request bodies and responses.
- Supports custom API base URL (defaults to
https://api.clickhouse.cloud). - Provides local development support via
http://localhost:2023.
Use cases of ClickHouse Cloud MCP Server
- Automate management of ClickHouse Cloud organizations.
- Programmatically manage ClickHouse Cloud services.
- Integrate ClickHouse Cloud operations into AI agent workflows.
FAQ from ClickHouse Cloud MCP Server
What prerequisites are needed?
You need a ClickHouse Cloud API Key. The server requires the environment variables CLICKHOUSE_API_KEY_ID, CLICKHOUSE_API_SECRET, and optionally CLICKHOUSE_API_URL.
How do I configure the API URL?
Set the CLICKHOUSE_API_URL environment variable. The default is https://api.clickhouse.cloud. Use http://localhost:2023 for local development.
What functionality is currently available?
The server provides tools to manage organizations and services. The README notes that the rest is TODO, indicating limited coverage of the full ClickHouse Cloud API.
How do I run the server with Claude Desktop?
Add a configuration entry to claude_desktop_config.json with the command node and the full path to dist/index.js, along with the required environment variables.
Does the server support authentication?
Yes, it authenticates using the ClickHouse OpenAPI Key ID and Secret provided via environment variables.
