OceanBase Skills
A collection of AI Agent Skills for OceanBase products — designed for use with Claude Code, Cursor, Windsurf, and any other agent that supports the Agent Skills Specification.
Each skill is a self-contained directory with a SKILL.md file (plus optional references/) that gives AI agents the domain knowledge needed to help you operate OceanBase products correctly and safely.
---
Available Skills
oceanbase-deploy — OceanBase Deployment & Operations (via obd)
| Skill | Description | |-------|-------------| | oceanbase-deploy | Overview & routing — start here if unsure which skill to use | | cluster-management | Cluster lifecycle: deploy, start, stop, upgrade, scale out, OCP CE takeover, monitoring | | tenant-management | Tenant CRUD, backup, restore, workload optimization | | seekdb (obd) | obd-managed SeekDB: primary-standby HA (switchover / failover / decouple) | | testing-and-benchmark | Sysbench, TPC-H, TPC-C, mysqltest benchmarks |
seekdb — SeekDB Full Lifecycle Skills (install / build / docs / CLI / import / query)
| Skill | Description | |-------|-------------| | seekdb | Overview & routing for standalone SeekDB | | seekdb/install | Install/deploy SeekDB via Homebrew, Docker, yum, apt, pip, Windows MSI | | seekdb/build | Build SeekDB from source for macOS, Linux, Android, Windows, Python wheel | | seekdb/docs | Documentation search — SQL syntax, vector/hybrid search, SDK, integration, deployment; ~1000 doc catalog entries | | seekdb/cli | seekdb-cli — SQL / schema / table data profiling / vector collections / AI models, all JSON output, AI-Agent friendly | | seekdb/importing | Import CSV/Excel data into SeekDB, with per-column vectorization | | seekdb/querying | Query/export — scalar filters, hybrid search (full-text + semantic), export results to CSV/Excel |
> More skills are on the way. Planned areas include OceanBase kernel tuning, SQL diagnostics, migration, and more.
---
Quick Start
Install via skills.sh (recommended)
# Install the oceanbase-deploy skill (includes all sub-skills)
npx skills add oceanbase/oceanbase-skills --skill oceanbase-deploy
# Install the seekdb standalone skill (install / build from source)
npx skills add oceanbase/oceanbase-skills --skill seekdb
# Or install all skills from this repo
npx skills add oceanbase/oceanbase-skillsManual install — clone and copy
Clone the repository, then copy the skill directories into your agent's skills folder. Cloning gives you a verifiable, version-pinned copy of the skill files instead of fetching agent instructions over the network at runtime.
git clone https://github.com/oceanbase/oceanbase-skills.git
cd oceanbase-skills
# oceanbase-deploy (includes all sub-skills)
mkdir -p .claude/skills
cp -R skills/oceanbase-deploy .claude/skills/
# SeekDB standalone skill bundle (install + build + docs + cli + importing + querying)
cp -R skills/seekdb .claude/skills/Cursor and Windsurf use the same layout under .cursor/skills/ and
.windsurf/skills/ respectively.
Browse the skills on GitHub
Read or download individual SKILL.md files directly in the repository:
https://github.com/oceanbase/oceanbase-skills/tree/master/skills/oceanbase-deploy---
Agent Integration
Claude Code / Cursor / Windsurf (via skills.sh)
npx skills add oceanbase/oceanbase-skills --skill oceanbase-deploynpx skills add automatically detects your IDE (Claude Code, Cursor, Windsurf, etc.) and installs to the right directory.
Claude Code (manual)
Use the clone-and-copy steps in Manual install above, or manually place SKILL.md files into .claude/skills/oceanbase-deploy/.
Other Agents
- System prompt / rules file: paste the content of
SKILL.md. - In-conversation context: paste the
SKILL.mdcontent at the start of your session.
---
Example Prompts
After loading the skills, ask your agent for concrete tasks. Below are examples grouped by skill.
Cluster Management
Deploy a local OceanBase community edition — just get it running quicklyUse config.yaml to deploy an OceanBase community edition cluster named test-clusterHelp me deploy OCPStart test-cluster directly and check its status after startupHow do I add Prometheus and Grafana monitoring to ob-testTenant Management
Create a tenant named mysql on test-clusterConfigure the backup path for the mysql tenant on test-cluster and run a backupSeekDB (obd-managed HA)
Deploy and start a SeekDB instanceCreate a SeekDB primary-standby cluster and tell me how to deploy the primary and standby separatelyShow the topology of seekdb-test — if the primary goes down, should I use switchover or failoverSeekDB (standalone install / build)
Install SeekDB on my MacDeploy a SeekDB instance with DockerBuild the Linux rpm package of SeekDB from sourceSeekDB (docs / cli / import / query)
What does the hybrid search SQL syntax look like in seekdb?Use seekdb-cli to list all tables and run the column profile for the orders tableImport this Excel file into seekdb and vectorize the Description columnSearch "deployment best practices" in the my_docs collection and export the top 20 results to results.xlsxTesting & Benchmark
Run a sysbench test against the mysql tenant on test-clusterGive me the full TPC-H command and parametersTips
- Want the agent to execute directly? Say "go ahead and run it".
- Want a plan first? Say "don't run anything yet, just give me the commands and steps".
- For destructive operations, say "I confirm high-risk operations are allowed" or "don't run destructive commands yet".
---
Repository Structure
oceanbase-skills/
├── .claude-plugin/
│ └── marketplace.json # skills.sh discovery manifest
├── README.md
├── AGENTS.md
├── package.json
├── LICENSE
└── skills/
├── oceanbase-deploy/ # OceanBase obd deployment & ops
│ ├── SKILL.md # Overview & routing
│ ├── README.md
│ ├── package.json
│ ├── cluster-management/ # Cluster lifecycle
│ │ ├── SKILL.md
│ │ └── references/
│ ├── tenant-management/ # Tenant ops
│ │ ├── SKILL.md
│ │ └── references/
│ ├── seekdb/ # obd-managed SeekDB HA
│ │ ├── SKILL.md
│ │ └── references/
│ └── testing-and-benchmark/ # Benchmarks
│ ├── SKILL.md
│ └── references/
└── seekdb/ # Standalone SeekDB — full lifecycle
├── SKILL.md # Overview & routing (6 sub-skills)
├── package.json
├── install/ # Install via Homebrew/Docker/yum/apt/pip/MSI
│ ├── SKILL.md
│ └── references/
├── build/ # Build from source (macOS/Linux/Android/Windows)
│ ├── SKILL.md
│ └── references/
├── docs/ # Documentation catalog (~1000 entries)
│ ├── SKILL.md
│ ├── references/ # seekdb-docs-catalog.jsonl + examples
│ ├── seekdb-docs/ # Mirrored doc tree (optional, refreshable)
│ └── scripts/ # Maintainer scripts (update_docs.sh, generate_catalog.py)
├── cli/ # seekdb-cli usage guide
│ ├── SKILL.md
│ └── references/
├── importing/ # CSV/Excel import + vectorization
│ ├── SKILL.md
│ ├── scripts/ # import_to_seekdb.py, read_excel.py
│ └── example-data/ # sample_products.csv / .xlsx
└── querying/ # Scalar + hybrid search, CSV/Excel export
├── SKILL.md
└── scripts/ # query_from_seekdb.pyEach skill follows the Agent Skills Specification:
| File | Purpose | |------|---------| | SKILL.md | Main skill content with YAML frontmatter — consumed by AI agents | | references/*.md | Supplemental documentation, loaded on demand to save context |
---
Contributing
Contributions are welcome. To add a new skill:
1. Create skills/<your-skill-name>/. 2. Write SKILL.md with YAML frontmatter (name, description, compatibility, metadata) and clear, agent-friendly instructions. 3. Add references/ for detailed supplemental content (loaded on demand, not always in context). 4. Keep SKILL.md under 500 lines; move details to references/. 5. Test your skill by loading it into Claude Code and running representative prompts.
Please keep skill content factual, concise, and safe — especially for destructive or irreversible operations.
---
