mirror of
https://github.com/supabase/agent-skills.git
synced 2026-01-26 19:09:51 +08:00
add info to project root
This commit is contained in:
61
README.md
Normal file
61
README.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# Agent Skills
|
||||
|
||||
A collection of skills for AI coding agents. Skills are packaged instructions and scripts that extend agent capabilities.
|
||||
|
||||
Skills follow the [Agent Skills](https://agentskills.io/) format.
|
||||
|
||||
## Available Skills
|
||||
|
||||
### postgresql-best-practices
|
||||
|
||||
PostgreSQL performance optimization guidelines from Supabase. Contains rules across 8 categories, prioritized by impact.
|
||||
|
||||
**Use when:**
|
||||
- Writing SQL queries or designing schemas
|
||||
- Implementing indexes or query optimization
|
||||
- Reviewing database performance issues
|
||||
- Configuring connection pooling or scaling
|
||||
- Working with Row-Level Security (RLS)
|
||||
|
||||
**Categories covered:**
|
||||
- Query Performance (Critical)
|
||||
- Connection Management (Critical)
|
||||
- Schema Design (High)
|
||||
- Concurrency & Locking (Medium-High)
|
||||
- Security & RLS (Medium-High)
|
||||
- Data Access Patterns (Medium)
|
||||
- Monitoring & Diagnostics (Low-Medium)
|
||||
- Advanced Features (Low)
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npx add-skill supabase/postgres-best-practices
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Skills are automatically available once installed. The agent will use them when relevant tasks are detected.
|
||||
|
||||
**Examples:**
|
||||
```
|
||||
Optimize this PostgreSQL query
|
||||
```
|
||||
```
|
||||
Review my schema for performance issues
|
||||
```
|
||||
```
|
||||
Help me add proper indexes to this table
|
||||
```
|
||||
|
||||
## Skill Structure
|
||||
|
||||
Each skill contains:
|
||||
- `SKILL.md` - Instructions for the agent
|
||||
- `AGENTS.md` - Compiled rules document (generated)
|
||||
- `rules/` - Individual rule files
|
||||
- `metadata.json` - Version and metadata
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user