Labsco
ClickHouse logo

setup

โœ“ Officialโ˜… 4

by clickhouse ยท part of clickhouse/clickhouse-claude-code-plugin

Guides users through setting up the ClickHouse MCP server connection bundled with this plugin. Use when the user first installs the plugin or has trouble connecting to ClickHouse.

๐Ÿ”ฅ๐Ÿ”ฅโœ“ VerifiedFreeAdvanced setup
๐Ÿ”Œ This skill ships inside the ClickHouse Claude Code Plugin plugin โ€” install the plugin and you also get an MCP server.

This is the playbook your agent receives when the skill activates โ€” you don't need to read it to use the skill, but it's here to audit before installing.

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.

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.