setup

Orienta os usuários na configuração da conexão do servidor ClickHouse MCP incluído neste plugin. Use quando o usuário instalar o plugin pela primeira vez ou tiver problemas…

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.

Mais skills de clickhouse

clickhouse-best-practices
clickhouse
28 regras de melhores práticas do ClickHouse organizadas por design de esquema, otimização de consultas e estratégia de ingestão de dados. Abrange três áreas críticas: seleção de chave primária e tipo de dados (decisões de design imutáveis), otimização de JOIN e consultas, e agrupamento de inserções com prevenção de mutações. Inclui 28 regras priorizadas por impacto, com regras de design de esquema e otimização de consultas marcadas como CRÍTICAS devido ao armazenamento colunar e mecanismos de índice esparso do ClickHouse. Fornece procedimentos de revisão estruturados para...
official
clickhouse-js-node-coding
clickhouse
Write idiomatic application code with the ClickHouse Node.js client (`@clickhouse/client`). Use this skill whenever a user is *building* against the Node.js…
official
clickhousectl-cloud-deploy
clickhouse
Use quando um usuário deseja implantar o ClickHouse na nuvem, ir para produção, usar o ClickHouse Cloud, hospedar um serviço gerenciado do ClickHouse ou migrar de um ambiente local…
official
clickstack-otel-collector
clickhouse
Use when a user wants to wire an OpenTelemetry collector into a Managed ClickStack service on ClickHouse Cloud, either by deploying a new local collector…
official
infra-clickhouse
clickhouse
Sets up and manages ClickHouse using the clickhousectl CLI — installs and runs a local ClickHouse server for development, and creates managed ClickHouse Cloud…
official
infra-postgres
clickhouse
Configura e gerencia o Postgres usando a CLI do clickhousectl — executa um Postgres local com suporte a Docker para desenvolvimento, e cria e opera o ClickHouse gerenciado…
official
clickhouse-best-practices
clickhouse
DEVE SER USADO ao revisar esquemas, consultas ou configurações do ClickHouse. Contém 31 regras que DEVEM ser verificadas antes de fornecer recomendações. Sempre leia…
official
triage-issues
clickhouse
Analisa uma issue do GitHub por vez. Lê a descrição, define labels e prioridade, pesquisa informações adicionais e fornece um resumo breve, mas…
official