setup

Hướng dẫn người dùng thiết lập kết nối máy chủ ClickHouse MCP đi kèm với plugin này. Sử dụng khi người dùng cài đặt plugin lần đầu hoặc gặp sự cố…

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.

Thêm skills từ clickhouse

clickhouse-best-practices
clickhouse
28 quy tắc thực hành tốt nhất cho ClickHouse được tổ chức theo thiết kế lược đồ, tối ưu hóa truy vấn và chiến lược nhập dữ liệu. Bao gồm ba lĩnh vực quan trọng: lựa chọn khóa chính và kiểu dữ liệu (các quyết định thiết kế không thể thay đổi), tối ưu hóa JOIN và truy vấn, cũng như gộp lô chèn và tránh đột biến. Bao gồm 28 quy tắc được ưu tiên theo mức độ tác động, với các quy tắc thiết kế lược đồ và tối ưu hóa truy vấn được đánh dấu QUAN TRỌNG do cơ chế lưu trữ cột và chỉ mục thưa của
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
Sử dụng khi người dùng muốn triển khai ClickHouse lên đám mây, chuyển sang môi trường sản xuất, sử dụng ClickHouse Cloud, lưu trữ dịch vụ ClickHouse được quản lý, hoặc di chuyển từ hệ thống cục bộ…
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
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
PHẢI SỬ DỤNG khi xem xét lược đồ ClickHouse, truy vấn hoặc cấu hình. Chứa 31 quy tắc PHẢI được kiểm tra trước khi đưa ra khuyến nghị. Luôn đọc…
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