Skip to content

risingwavelabs/agent-skills

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Agent Skills for RisingWave

Docs | Installation | Skills | Contributing


Official Agent Skills for RisingWave — the streaming SQL database. These skills help AI coding agents adopt best practices when building real-time pipelines, designing materialized views, configuring CDC ingestion, and optimizing streaming workloads.

Compatible with Claude Code, GitHub Copilot, Cursor, Windsurf, Gemini CLI, and 18+ other AI agents.

Installation

npx skills add risingwavelabs/agent-skills

The CLI auto-detects installed agents and prompts you to select where to install.

Install a specific skill

npx skills add risingwavelabs/agent-skills --skill risingwave
npx skills add risingwavelabs/agent-skills --skill risingwave-best-practices

Claude Code Plugin

claude plugin marketplace add risingwavelabs/agent-skills
claude plugin install risingwave@risingwave-agent-skills
claude plugin install risingwave-best-practices@risingwave-agent-skills

What is this?

Agent Skills are packaged instructions that extend AI coding agents with domain-specific expertise. This repository provides skills for RisingWave — covering connections, the Source → Materialized View → Sink pipeline pattern, CDC ingestion, time-windowed aggregations, watermarks, and streaming SQL best practices.

When an agent loads these skills, it understands RisingWave-specific concepts that differ from standard PostgreSQL: port 4566, CREATE SOURCE vs CREATE TABLE, EMIT ON WINDOW CLOSE, watermark semantics, BACKGROUND_DDL, and more.

Skills follow the open specification at agentskills.io.

Available Skills

risingwave

Core skill covering connections, MCP server setup, and the fundamental pipeline pattern.

Use when:

  • Connecting to RisingWave (port 4566, psql, JDBC, any PostgreSQL client)
  • Setting up the RisingWave MCP server
  • Creating sources, materialized views, or sinks
  • Ingesting from Kafka, CDC databases (PostgreSQL, MySQL), or cloud storage
  • Writing time-windowed aggregations (TUMBLE, HOP, SESSION)
  • Using watermarks and EMIT ON WINDOW CLOSE
  • Querying the system catalog (rw_catalog)
risingwave-best-practices

14 rules covering schema design, materialized view patterns, CDC setup, sink configuration, and performance — prioritized by impact.

Category Rules Impact
Schema Design 3 CRITICAL / HIGH
Materialized Views 3 CRITICAL / HIGH
Streaming SQL 3 CRITICAL / HIGH
Sink Configuration 2 HIGH / MEDIUM
Performance 3 HIGH / MEDIUM

Use when:

  • Designing sources, tables, or pipelines
  • Writing or reviewing materialized views
  • Configuring CDC from PostgreSQL or MySQL
  • Setting up sinks to Kafka, Iceberg, or other destinations
  • Debugging slow backfills or high-volume sink output

Quick Start

After installation, your AI agent will reference these skills when working with RisingWave. Example prompts:

Create a Kafka source for user events and a materialized view that counts events per minute
Set up PostgreSQL CDC into RisingWave and join the CDC table with a Kafka stream
Why is my EMIT ON WINDOW CLOSE materialized view not producing any output?
Create an Iceberg sink for my fraud detection materialized view
Review this RisingWave pipeline for best practices

Supported Agents

Skills are agent-agnostic — the same skill works across all supported AI coding assistants:

Agent Config Directory
Claude Code .claude/skills/
Cursor .cursor/skills/
Windsurf .windsurf/skills/
GitHub Copilot .github/skills/
Gemini CLI .gemini/skills/
Cline .cline/skills/
Codex .codex/skills/
Goose .goose/skills/
Roo Code .roo/skills/
OpenHands .openhands/skills/

And others including Amp, Kiro CLI, Trae, Zencoder, and more.

Contributing

See CONTRIBUTING.md to add new rules, improve existing skills, or propose a new skill.

License

Apache 2.0 — see LICENSE for details.

About

Agent Skills for RisingWave.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors