MCP Server Clickhouse

🚀 ClickHouse Cloud MCP Server

This MCP server provides tools for interacting with the ClickHouse Cloud API (v1). It allows for the management of organizations and services, and other features are under development.

🚀 Quick Start

This MCP server offers tools to interact with the ClickHouse Cloud API (v1), enabling the management of organizations and services. Other features are currently in development.

✨ Features

• Expose ClickHouse Cloud API endpoints through the MCP tool.
• Authenticate using the ClickHouse OpenAPI Key ID and Secret, where the latter can be provided via environment variables.
• Handle JSON request bodies and responses.

📦 Installation

1. Clone this repository and install the dependencies:

npm install

2. Build the TypeScript code:

npm run build

This will create a dist directory containing the compiled JavaScript files.

📚 Documentation

Prerequisites

You need a ClickHouse Cloud API key.

Configuration

This server requires the following environment variables to be set:

• CLICKHOUSE_API_KEY_ID: Your ClickHouse Cloud API Key ID.
• CLICKHOUSE_API_SECRET: Your ClickHouse Cloud API Key Secret.
• CLICKHOUSE_API_URL: The base URL of the ClickHouse Cloud API (default is https://api.clickhouse.cloud). Use http://localhost:2023 for local development.

Integration with Claude Desktop

Add the following configuration to your claude_desktop_config.json file:

{
  "mcpServers": {
    "clickhouse": {
      "command": "node",
      "args": [
        "/full/path/to/dist/index.js"
      ],
      "env": {
        "CLICKHOUSE_API_KEY_ID": "key id",
        "CLICKHOUSE_API_SECRET": "key secret",
        "CLICKHOUSE_API_URL": "http://localhost:2023"
      }
    }
  }
}