skilld
All skills
clickhouse avatar

/clickhouse-best-practices

@d284161 official
by clickhouseclickhouse/agent-skills543 stars
39

MUST USE when reviewing ClickHouse schemas, queries, or configurations. Contains 31 rules that MUST be checked before providing recommendations. Always read relevant rule files and cite specific rules in responses.

Ask your Agent

Use this Skill: https://skilld.dev/gh/clickhouse/agent-skills/clickhouse-best-practices

This session only. Nothing lands on disk.

README.md

≈474 tokens on demand. Your agent reads this file only when SKILL.md points to it.

ClickHouse Best Practices

Agent skill providing comprehensive ClickHouse guidance for schema design, query optimization, and data ingestion.

Installation

npx skills add ClickHouse/clickhouse-agent-skills

What's Included

31 atomic rules organized by prefix:

Prefix Count Coverage
schema-pk-* 4 PRIMARY KEY selection, cardinality ordering
schema-types-* 5 Data types, LowCardinality, Nullable
schema-partition-* 4 Partitioning strategy, lifecycle management
schema-json-* 1 JSON type usage
query-join-* 5 JOIN algorithms, filtering, alternatives
query-index-* 1 Data skipping indices
query-mv-* 2 Incremental and refreshable MVs
insert-batch-* 1 Batch sizing (10K-100K rows)
insert-async-* 2 Async inserts, data formats
insert-mutation-* 2 Mutation avoidance
insert-optimize-* 1 OPTIMIZE FINAL avoidance
agent-connect-* 1 MCP + CLI connectivity, credentials, output formats
agent-discovery-* 1 7-step schema discovery workflow
agent-query-* 1 Query safety limits, progressive exploration

Trigger Phrases

This skill activates when you:

  • "Create a table for..."
  • "Optimize this query..."
  • "Design a schema for..."
  • "Why is this query slow?"
  • "How should I insert data into..."
  • "Should I use UPDATE or..."
  • "Connect Claude to ClickHouse..."
  • "Set up MCP for ClickHouse..."
  • "Query ClickHouse from an agent..."

Files

File Purpose
SKILL.md Quick reference and decision frameworks
AGENTS.md Complete rule reference (auto-generated)
rules/*.md Individual rule definitions

Related Documentation

All rules link to official ClickHouse documentation:

Source: SKILL.md on GitHub

Third-party checks

No alerts17d5 checks · Risk SAFE
  • Gen Agent Trust Hub17d

    This skill provides comprehensive best practices for ClickHouse database management, including schema design, query optimization, and ingestion strategies. It includes robust safety guardrails for AI agents, such as mandatory query limits, execution timeouts, and a structured schema discovery workflow. All external references and tools trace back to official ClickHouse vendor resources.

  • Socket17d

    No alerts

  • Snyk17d

    Risk: LOW · No issues

  • Runlayer7mo

    8/34 files flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Provenance

Signed by skilld at d284161. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 3 days ago.

Activeupdated 5 months ago

Capability

metadata
{
  "author": "ClickHouse Inc",
  "version": "0.4.0"
}

Topics

README badge

README badge for clickhouse/agent-skills/clickhouse-best-practices

What it does

Provides 31 ClickHouse-specific rules organized by priority across schema design, query optimization, data ingestion, and agent connectivity. Use this skill to validate schemas, review queries, and establish safe agent workflows with proper connection setup, schema discovery, and query safety procedures.

Generated from the current SKILL.md.

Frequently asked

When should I use this skill?
Use this skill when reviewing ClickHouse schemas, queries, or data ingestion strategies. It contains 31 rules covering primary key design, data types, JOINs, partitioning, and insert batching that you must check before providing ClickHouse recommendations.
Does this skill help with AI agent connectivity to ClickHouse?
Yes. The skill includes rules for MCP and CLI connection setup, schema discovery workflows, and query safety (LIMIT, timeouts, progressive exploration) specific to AI agents querying ClickHouse.
What should I do if a rule doesn't exist for my question?
Fall back to the LLM's ClickHouse knowledge, search the official ClickHouse documentation, or use web search. Always cite your source in the response.
Are the rules mandatory or advisory?
The rules are mandatory checks before answering ClickHouse questions. They encode ClickHouse-specific behaviors (columnar storage, merge tree mechanics, sparse indexes) where general database intuition can be misleading.
Can I use this skill for INSERT performance tuning?
Yes. The skill covers batch sizing (10K-100K rows), async inserts for high-frequency small batches, mutation avoidance (ReplacingMergeTree instead of ALTER UPDATE), and OPTIMIZE TABLE risks.

Generated from the current SKILL.md. These answers refresh after source changes.