https://github.com/ClickHouse/agent-skills
The official Agent Skills for ClickHouse and ClickHouse Cloud
https://github.com/ClickHouse/agent-skills
agents clickhouse
Last synced: about 1 month ago
JSON representation
The official Agent Skills for ClickHouse and ClickHouse Cloud
- Host: GitHub
- URL: https://github.com/ClickHouse/agent-skills
- Owner: ClickHouse
- License: apache-2.0
- Created: 2026-01-15T16:36:20.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-02-26T09:11:41.000Z (about 1 month ago)
- Last Synced: 2026-02-26T14:53:44.076Z (about 1 month ago)
- Topics: agents, clickhouse
- Language: JavaScript
- Homepage: https://clickhouse.ai
- Size: 72.3 KB
- Stars: 323
- Watchers: 3
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Notice: NOTICE
- Agents: AGENTS.md
Awesome Lists containing this project
- awesome-agent-skills - clickhouse
- awesome-agent-skills - ClickHouse/agent-skills - The official Agent Skills for [ClickHouse](https://clickhouse.com/). These skills help LLMs and agents to adopt best practices when working with ClickHouse. (Table of Contents / Skill by ClickHouse)
README
# ClickHouse Agent Skills
The official Agent Skills for [ClickHouse](https://clickhouse.com/). These skills help LLMs and agents to adopt best practices when working with ClickHouse.
You can use these skills with open-source ClickHouse and managed ClickHouse Cloud. [Try ClickHouse Cloud with $300 in free credits](https://clickhouse.com/cloud?utm_medium=github&utm_source=github&utm_ref=agent-skills).
## Installation
```bash
npx skills add clickhouse/agent-skills
```
The CLI auto-detects installed agents and prompts you to select where to install.
## What is this?
Agent Skills are packaged instructions that extend AI coding agents (Claude Code, Cursor, Copilot, etc.) with domain-specific expertise. This repository provides skills for ClickHouse databases—covering schema design, query optimization, and data ingestion patterns.
When an agent loads these skills, it gains knowledge of ClickHouse best practices and can apply them while helping you design tables, write queries, or troubleshoot performance issues.
Skills follow the open specification at [agentskills.io](https://agentskills.io).
## Available Skills
### ClickHouse Best Practices
**28 rules** covering schema design, query optimization, and data ingestion—prioritized by impact.
| Category | Rules | Impact |
|----------|-------|--------|
| Primary Key Selection | 4 | CRITICAL |
| Data Type Selection | 5 | CRITICAL |
| JOIN Optimization | 5 | CRITICAL |
| Insert Batching | 1 | CRITICAL |
| Mutation Avoidance | 2 | CRITICAL |
| Partitioning Strategy | 4 | HIGH |
| Skipping Indices | 1 | HIGH |
| Materialized Views | 2 | HIGH |
| Async Inserts | 2 | HIGH |
| OPTIMIZE Avoidance | 1 | HIGH |
| JSON Usage | 1 | MEDIUM |
**Location:** [`skills/clickhouse-best-practices/`](./skills/clickhouse-best-practices/)
**For humans:** Read [SKILL.md](./skills/clickhouse-best-practices/SKILL.md) for an overview, or [AGENTS.md](./skills/clickhouse-best-practices/AGENTS.md) for the complete compiled guide.
**For agents:** The skill activates automatically when you work with ClickHouse—creating tables, writing queries, or designing data pipelines.
## Quick Start
After installation, your AI agent will reference these best practices when:
- Creating new tables with `CREATE TABLE`
- Choosing `ORDER BY` / `PRIMARY KEY` columns
- Selecting data types for columns
- Optimizing slow queries
- Writing or tuning JOINs
- Designing data ingestion pipelines
- Handling updates or deletes
Example prompt:
> "Create a table for storing user events with fields for user_id, event_type, properties (JSON), and timestamp"
The agent will apply relevant rules like proper column ordering in the primary key, appropriate data types, and partitioning strategy.
## Supported Agents
Skills are **agent-agnostic**—the same skill works across all supported AI coding assistants:
| Agent | Config Directory |
|-------|------------------|
| [Claude Code](https://claude.ai/code) | `.claude/skills/` |
| [Cursor](https://cursor.sh) | `.cursor/skills/` |
| [Windsurf](https://codeium.com/windsurf) | `.windsurf/skills/` |
| [GitHub Copilot](https://github.com/features/copilot) | `.github/skills/` |
| [Gemini CLI](https://github.com/google-gemini/gemini-cli) | `.gemini/skills/` |
| [Cline](https://github.com/cline/cline) | `.cline/skills/` |
| [Codex](https://openai.com/codex) | `.codex/skills/` |
| [Goose](https://github.com/block/goose) | `.goose/skills/` |
| [Roo Code](https://roo.ai) | `.roo/skills/` |
| [OpenHands](https://github.com/All-Hands-AI/OpenHands) | `.openhands/skills/` |
And 13 more including Amp, Kiro CLI, Trae, Zencoder, and others.
The installer detects which agents you have by checking for their configuration directories. If an agent isn't listed, either install it first or create its config directory manually (e.g., `mkdir -p ~/.cursor`).
## License
Apache 2.0 — see [LICENSE](./LICENSE) for details.