Setup

作者 ClickHousee3229ed4aafb無授權條款7 個星標收錄於 2026年10月8日更新於 2026年10月8日儲存庫3 天前更新

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.

AI 產生的概覽

引導設定並排解隨外掛提供的 ClickHouse Cloud 遠端 MCP 伺服器連線。

功能
引導使用者確認 ClickHouse MCP 伺服器已連線、使用 ClickHouse Cloud 認證透過 OAuth 驗證,並以簡單查詢測試連線。它也列出伺服器未出現、驗證錯誤與網路逾時等問題的排解步驟,並說明 Claude Code 對 MCP 工具呼叫的 30 秒逾時限制。文件也介紹該伺服器提供的唯讀工具,涵蓋組織、服務、資料庫、ClickPipes、備份與帳務。
適用情境
適用於首次安裝外掛並需要建立 ClickHouse MCP 連線時,或使用者連線 ClickHouse 遇到問題時。當查詢失敗或逾時、需要了解逾時限制時也適用。
執行需求
需要隨外掛提供的 ClickHouse Cloud 遠端 MCP 伺服器、用於 OAuth 驗證的 ClickHouse Cloud 帳戶,以及連線至遠端端點的網路存取。不含指令碼,僅為說明文件。

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.

來源與署名

來源:ClickHouse/clickhouse-claude-code-plugin位於skills/setup提交e3229ed

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架