Skip to main content

At a glance

Credentials

Set these per environment. See Connect an integration.
VariableRequiredDescription
CLICKHOUSE_KEY_IDYesClickHouse Cloud API key ID (used as the HTTP Basic username) Docs.
CLICKHOUSE_KEY_SECRETYesClickHouse Cloud API key secret (used as the HTTP Basic password) Docs.

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.
  • 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: https://clickhouse.com/docs/cloud/manage/api/api-overview

Tools

ToolAccessDescription
List OrganizationsReadList organizations the API key has access to
Get OrganizationReadGet details of an organization
List ServicesReadList all ClickHouse services in an organization
Get ServiceReadGet details of a ClickHouse service, including endpoints and state

Example prompts

  • List my ClickHouse Cloud services with their state, provider, and region.
  • Get the details of my ClickHouse Cloud service and tell me whether it is running and where its endpoints are.