setup

Проводит пользователя через настройку подключения к серверу ClickHouse MCP, встроенному в этот плагин. Используйте, когда пользователь впервые устанавливает плагин или сталкивается с проблемами…

npx skills add https://github.com/clickhouse/clickhouse-claude-code-plugin --skill setup

ClickHouse Plugin Setup

This plugin includes the ClickHouse Cloud Remote MCP server at https://mcp.clickhouse.cloud/mcp. It provides secure, read-only access to your ClickHouse Cloud clusters.

Setup Steps

  1. Verify the MCP server is connected: Check that the ClickHouse MCP server appears in your available tools. If it does, you're ready to go.

  2. Authenticate via OAuth: The MCP server uses OAuth with your ClickHouse Cloud credentials. Follow the prompts when first connecting to authorize access.

  3. Test the connection: Try listing databases or running a simple SELECT query to confirm everything works.

Troubleshooting

  • Server not appearing: Run /reload-plugins to reload plugin MCP servers.
  • Authentication errors: Re-authenticate by following the OAuth flow when prompted.
  • Connection timeouts: Verify your network can reach https://mcp.clickhouse.cloud. The MCP server is a remote HTTP endpoint and requires internet access.

Claude Code Timeout Limitation

Claude Code enforces a 30-second timeout on all MCP tool calls. This cannot be changed by the user or the MCP server. While the run_select_query tool accepts a timeoutSeconds parameter (default 300s, max 3600s), Claude Code will kill the connection after 30 seconds regardless of this setting.

Implications:

  • Keep queries simple and fast — complex analytical queries that take longer than 30 seconds will fail
  • Use LIMIT clauses to bound result sets
  • Prefer querying materialized views or pre-aggregated tables over raw scans of large tables
  • If a query times out, break it into smaller, faster queries rather than increasing timeoutSeconds

What the MCP Server Provides

Once connected, the ClickHouse MCP server provides these tools:

Organization & Service Management

  • get_organizations — list all accessible ClickHouse Cloud organizations
  • get_organization_details — details of a single organization
  • get_services_list — list all services in an organization
  • get_service_details — details of a single service

Database Exploration

  • list_databases — list all databases in a service
  • list_tables — list tables in a database (supports like/notLike filtering)
  • run_select_query — execute read-only SELECT queries (⚠️ subject to 30s Claude Code timeout)

ClickPipes

  • list_clickpipes — list all ClickPipes for a service
  • get_clickpipe — details of a specific ClickPipe

Backups

  • list_service_backups — list all backups for a service
  • get_service_backup_details — details of a specific backup
  • get_service_backup_configuration — backup schedule and retention settings

Billing

  • get_organization_cost — billing and usage cost data (max 31-day window)

All tools are read-only. See the ClickHouse MCP docs for details.

Best Practices Skill

This plugin also includes the clickhouse-best-practices skill with 28 rules covering schema design, query optimization, and insert strategy. That skill activates automatically when you work with ClickHouse -- no setup needed.

Больше skills от clickhouse

chdb-sql
clickhouse
Запускайте ClickHouse SQL напрямую в Python — сервер не требуется. Выполняйте запросы к локальным файлам, удалённым базам данных и облачным хранилищам с полной мощью ClickHouse SQL.
official
chdb-datastore
clickhouse
DataStore — это ленивая замена pandas на основе ClickHouse. Ваш существующий код pandas работает без изменений, но операции компилируются в оптимизированный SQL и выполняются только тогда, когда нужны результаты (например, print(), len(), итерация).
official
clickhouse-architecture-advisor
clickhouse
ОБЯЗАТЕЛЬНО ИСПОЛЬЗОВАТЬ при проектировании архитектур ClickHouse, выборе между шаблонами приема данных или моделирования, или переводе лучших практик в системные решения, специфичные для рабочей нагрузки…
official
clickhouse-best-practices
clickhouse
28 правил лучших практик ClickHouse, организованных по проектированию схемы, оптимизации запросов и стратегии загрузки данных. Охватывает три критически важные области: выбор первичного ключа и типов данных (неизменяемые проектные решения), оптимизация JOIN и запросов, а также пакетная вставка с избеганием мутаций. Включает 28 правил, приоритизированных по влиянию, причем правила проектирования схемы и оптимизации запросов помечены как КРИТИЧЕСКИЕ из-за колоночного хранения ClickHouse и механики разреженных индексов. Предоставляет структурированные процедуры проверки для...
official
clickhousectl-cloud-deploy
clickhouse
Используйте, когда пользователь хочет развернуть ClickHouse в облаке, перейти в продакшн, использовать ClickHouse Cloud, разместить управляемый сервис ClickHouse или мигрировать с локального…
official
clickhousectl-local-dev
clickhouse
Используйте, когда пользователь хочет создать приложение с ClickHouse, настроить локальную среду разработки ClickHouse, установить ClickHouse, создать локальный сервер,…
official
clickhouse-js-node-coding
clickhouse
Ссылка: https://clickhouse.com/docs/integrations/javascript
official
clickhouse-js-node-troubleshooting
clickhouse
Ссылка: https://clickhouse.com/docs/integrations/javascript
official