setup

Guide les utilisateurs dans la configuration de la connexion au serveur ClickHouse MCP fourni avec ce plugin. À utiliser lors de la première installation du plugin ou en cas de problème…

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.

Plus de skills de clickhouse

clickhouse-best-practices
clickhouse
28 règles de bonnes pratiques ClickHouse organisées par conception de schéma, optimisation des requêtes et stratégie d'ingestion de données. Couvre trois domaines critiques : sélection de la clé primaire et des types de données (décisions de conception immuables), optimisation des JOIN et des requêtes, et regroupement des insertions avec évitement des mutations. Inclut 28 règles priorisées par impact, avec des règles de conception de schéma et d'optimisation des requêtes marquées CRITIQUES en raison du stockage columnar et des mécanismes d'index clairsemés de ClickHouse. Fournit des procédures de révision structurées pour...
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
Utiliser lorsque l'utilisateur souhaite déployer ClickHouse dans le cloud, passer en production, utiliser ClickHouse Cloud, héberger un service ClickHouse géré, ou migrer depuis un environnement local…
official
clickstack-otel-collector
clickhouse
À utiliser lorsqu'un utilisateur souhaite connecter un collecteur OpenTelemetry à un service Managed ClickStack sur ClickHouse Cloud, soit en déployant un nouveau collecteur local…
official
infra-clickhouse
clickhouse
Configure et gère ClickHouse à l'aide de la CLI clickhousectl — installe et exécute un serveur ClickHouse local pour le développement, et crée des services gérés ClickHouse Cloud…
official
infra-postgres
clickhouse
Sets up and manages Postgres using the clickhousectl CLI — runs a local Docker-backed Postgres for development, and creates and operates managed ClickHouse…
official
clickhouse-best-practices
clickhouse
À UTILISER OBLIGATOIREMENT lors de l'examen des schémas, requêtes ou configurations ClickHouse. Contient 31 règles qui DOIVENT être vérifiées avant de fournir des recommandations. Toujours lire…
official
triage-issues
clickhouse
Analyzes a single GitHub issue at a time. Reads the description, defines labels and priority, researches additional information, and provides a short but…
official