Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

ClickHouse (BYOK) — connector documentation

  • MCP endpoint: https://byok-clickhouse.connectorbay.com/mcp
  • REST API: POST https://byok-clickhouse.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-clickhouse.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own ClickHouse ClickHouse Cloud API key ID, sent in the X-Upstream-Key header and the API key secret in X-Upstream-Key-2 of every request (never stored, logged or cached)
  • Health: https://byok-clickhouse.connectorbay.com/health · Tool schemas: https://byok-clickhouse.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-clickhouse · agent@connectorbay.com

What ClickHouse (BYOK) is for

ClickHouse (BYOK) lets an AI assistant read your own ClickHouse data through the ClickHouse API with a key you supply (ClickHouse Cloud API key ID). Read-only: 11 tools (list_organizations, get_organization, list_services, get_service, list_backups, get_backup_configuration, get_usage_cost, list_clickpipes, list_postgres_services, list_api_keys, list_activities). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.clickhouse.cloud. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by ClickHouse. ClickHouse and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which ClickHouse Cloud organization does my key belong to?"
  • "Show details of my ClickHouse Cloud organization"
  • "Which ClickHouse Cloud services are running and where?"
  • "How is my ClickHouse service configured?"
  • "When was the last successful backup of my ClickHouse service?"
  • "How often is my ClickHouse service backed up and for how long are backups kept?"

What it does

  • list_organizations: List the organizations the key belongs to (an API key resolves to its own organization).
  • get_organization: Get one organization with its private endpoints, BYOC configuration and capabilities.
  • list_services: List all services of the organization with provider, region, state, tier, ClickHouse version, replicas and autoscaling.
  • get_service: Get one service with its state, tier, replica counts, autoscaling and idle settings.
  • list_backups: List the backups of a service, newest first, with status, type, size and duration.
  • get_backup_configuration: Get the backup schedule of a service: period, retention and start time.
  • get_usage_cost: Get the usage cost of the organization in ClickHouse Cloud credits for a date range of at most 31 days, per day and entity.
  • list_clickpipes: List the ClickPipes (managed ingestion pipelines) of a service with state, scaling and destination table.
  • list_postgres_services: List the managed Postgres services of the organization with version, size, HA type, region and state.
  • list_api_keys: List the API keys of the organization with name, state, roles, key suffix, creation, expiry and last use. Secrets are never returned.
  • list_activities: List organization audit activities (key, service, backup and member changes) in a date range. Actor names, e-mails and IP addresses are not returned.

BYOK key

You bring your own ClickHouse ClickHouse Cloud API key ID (https://console.clickhouse.cloud). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.clickhouse.cloud over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the ClickHouse API (api.clickhouse.cloud) with a BYOK key; documentation: https://clickhouse.com/docs/cloud/manage/openapi. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by ClickHouse. ClickHouse and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your ClickHouse account.

Built for: Worldwide. Languages: English.