Skip to main content

​
At a glance

  • Availability: Experimental (how to enable).
  • Authentication: Basic auth.
  • Connection: HTTP Basic auth with CLICKHOUSE_KEY_ID as the username and CLICKHOUSE_KEY_SECRET as the password.
  • Provider documentation: Authentication reference.

​
Credentials

Set these per environment. See Connect an integration.

​
Setup

  1. Sign in to ClickHouse Cloud: Go to https://console.clickhouse.cloud and sign in (a free trial organization with one service is enough for testing).
  2. Create an API key: In the console, open the API Keys tab in the left menu, click New API Key, choose permissions (developer for read-only is sufficient for these tools), and set an expiration.
  3. Copy the key ID and secret: Copy the Key ID and Key Secret immediately - they are not shown again. Add them to your .env as CLICKHOUSE_KEY_ID and CLICKHOUSE_KEY_SECRET.
  4. Verify access: Run List Organizations, then List Services with the organization ID it returns.

​
Provider notes

  • Authentication is HTTP Basic: the key ID is the username and the key secret is the password
  • This connector targets the ClickHouse Cloud management API (api.clickhouse.cloud), not the SQL interface of your ClickHouse database
  • API responses wrap payloads in a top-level ‘result’ field
Provider API reference.

​
Tools

​
Verify the connection

Call a read tool such as clickhouse__list_organizations with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.