--- name: supabase description: "Official Supabase & Postgres agent skills: Database, Auth, SSR, RLS policies, migrations, CLI, query performance, and indexing best practices." license: MIT metadata: author: supabase repo: supabase/agent-skills version: "1.1.2" ---
Supabase Agent Skills
Agent Skills to help developers using AI agents with Supabase. Agent Skills are folders of instructions, scripts, and resources that agents can discover and use to do things more accurately and efficiently. Compatible with 18+ AI agents including Claude Code, GitHub Copilot, Cursor, Cline, and many others.
Overview & Capabilities
- When working with Supabase, this skill guides agents through:
- Core Database & Auth: Setting up
supabase-jsand@supabase/ssrwith secure cookie-based session management across Next.js, React, SvelteKit, Astro, and Remix. - Security & RLS Bulletproofing: Eliminating common security traps (BOLA/IDOR, avoiding deprecated
auth.role(), requiringTO authenticatedwith ownership predicates andWITH CHECK, preventingSECURITY DEFINERprivilege escalation). - Database Migrations & Tooling: Using the Supabase CLI, declarative schemas (
supabase/schemas/), advisors (supabase db advisors), and the Supabase MCP server. - Postgres Performance & Indexing: Diagnosing slow queries, avoiding sequential scans, analyzing EXPLAIN plans, creating targeted B-tree and partial indexes, and optimizing connection pooling with PgBouncer.
Subgroups Included
1. Supabase Core & SSR Auth Architecture — Client libraries and SSR integrations (supabase-js, @supabase/ssr) in Next.js, React, SvelteKit, Astro, and Remix with secure cookie session handling. 2. Bulletproof RLS & Security Traps — Row Level Security on exposed schemas, avoiding BOLA/IDOR by pairing TO authenticated with ownership checks, and preventing SECURITY DEFINER privilege escalation. 3. CLI, MCP Server & Declarative Migrations — Schema management via Supabase CLI, imperative/declarative migration workflows, Supabase db advisors, and MCP server configuration. 4. Postgres Query Performance & Indexing — Critical query optimization guidelines, sequential scan reduction, B-tree/partial indexing strategies, and EXPLAIN plan analysis. 5. Connection Pooling & Concurrency Locking — Connection management with PgBouncer, preventing connection exhaustion, transaction lock avoidance, and concurrency control. 6. Monitoring, Diagnostics & Storage Access — Troubleshooting HTTP/PostgREST errors, inspecting ClickHouse logs in Logs Explorer, and configuring multi-action Storage permissions.
Installation Quick Start
Any Agent (Skills CLI)
bash
npx skills add supabase/agent-skills
Claude Code Plugin
```bash # 1. Install supabase/agent-skills marketplace claude plugin marketplace add supabase/agent-skills
2. Install the plugins
claude plugin install supabase@supabase-agent-skills claude plugin install postgres-best-practices@supabase-agent-skills ```
Cursor / Codex / Copilot
bash
npx skills add supabase/agent-skills --agent cursor
Common Example Prompts
- "Optimize this Postgres query" - "Review my schema for performance issues" - "Help me set up Supabase Auth with Next.js" - "Help me add proper indexes to this table" - "Audit my RLS policies for security vulnerabilities"
Subgroup 1: Supabase Core & SSR Auth Architecture
Supabase
Core Principles
1. Supabase changes frequently — verify against changelog and current docs before implementing. Do not rely on training data for Supabase features. Function signatures, config.toml settings, and API conventions change between versions.
First, fetch https://supabase.com/changelog.md (a lightweight summary index — not a heavy pull), scan for breaking-change tags relevant to your task, and follow the linked page for any that apply. Then look up the relevant topic using the documentation access methods below.
2. Verify your work. After implementing any fix, run a test query to confirm the change works. A fix without verification is incomplete.
3. Recover from errors, don't loop. If an approach fails after 2-3 attempts, stop and reconsider. Try a different method, check documentation, inspect the error more carefully, and review relevant logs when available. Supabase issues are not always solved by retrying the same command, and the answer is not always in the logs, but logs are often worth checking before proceeding.
4. Exposing tables to the Data API: Depending on the user's Data API settings, newly created tables may not be automatically exposed via the Data (REST) API. If this is the case, anon and authenticated roles will need to be explicitly granted access.
Note that this is separate from RLS, which controls which _rows_ are visible once a table is accessible, not whether the table is accessible at all.
When a user reports a SQL-created table is unexpectedly inaccessible, check their Data API settings and whether the roles have been granted access via explicit GRANT SQL. When granting public (anon/authenticated) access, always enable RLS too. See Exposing a Table to the Data API for the full setup workflow.
5. RLS in exposed schemas.
Enable RLS on every table in any exposed schema, which includes public by default. This is critical in Supabase because tables in exposed schemas can be reachable through the Data API when the anon/authenticated roles have access (see Exposing a Table to the Data API). For private schemas, prefer RLS as defense in depth. After enabling RLS, create policies that match the actual access model rather than defaulting every table to the same auth.uid() pattern.
6. Security checklist. When working on any Supabase task that touches auth, RLS, views, storage, or user data, run through this checklist. These are Supabase-specific security traps that silently create vulnerabilities:
- Auth and session security
- - Never use `user_metadata` claims in JWT-based authorization decisions. In Supabase,
raw_user_meta_datais user-editable and can appear inauth.jwt(), so it is unsafe for RLS policies or any other authorization logic. Store authorization data inraw_app_meta_data/app_metadatainstead. - - Deleting a user does not invalidate existing access tokens. Sign out or revoke sessions first, keep JWT expiry short for sensitive apps, and for strict guarantees validate
session_idagainstauth.sessionson sensitive operations. - - If you use `app_metadata` or `auth.jwt()` for authorization, remember JWT claims are not always fresh until the user's token is refreshed.
- API key and client exposure
- - Never expose the `service_role` or secret key in public clients. Prefer publishable keys for frontend code. Legacy
anonkeys are only for compatibility. In Next.js, anyNEXT_PUBLIC_env var is sent to the browser. - - Use scoped personal access tokens for the Management API, CLI, and MCP server. A classic personal access token carries the user's full account access, on every organization and project. For scripts, CI, and agents, have the user create a scoped token limited to the organizations, projects, and permissions the task needs. The personal access tokens guide lists the permission each Management API endpoint and MCP tool requires. Look permissions up there rather than guessing.
- RLS, views, and privileged database code
- - Views bypass RLS by default. In Postgres 15 and above, use
CREATE VIEW ... WITH (security_invoker = true). In older versions of Postgres, protect your views by revoking access from theanonandauthenticatedroles, or by putting them in an unexposed schema. - - UPDATE requires a SELECT policy. In Postgres RLS, an UPDATE needs to first SELECT the row. Without a SELECT policy, updates silently return 0 rows — no error, just no change.
- - `auth.role()` is deprecated — use the `TO` clause instead. Supabase has deprecated
auth.role()in favour of specifying the target role directly on the policy withTO authenticatedorTO anon. Beyond deprecation,auth.role() = 'authenticated'breaks silently when anonymous sign-ins are enabled, because anonymous users carry theauthenticatedPostgres role and pass the check regardless of whether the user is genuinely signed in. - ```sql
- -- Deprecated (do not use)
- create policy "example" on table_name for select
- using ( auth.role() = 'authenticated' );
- ```
- - `TO authenticated` alone is authentication without authorization (BOLA / IDOR). Using
TO authenticatedonly checks the role — it does not restrict which rows a user can access. The correct pattern combinesTO authenticatedwith an ownership predicate inUSING: - ```sql
- create policy "example" on table_name for select
- to authenticated
- using ( (select auth.uid()) = user_id );
- ```
- - UPDATE policies require both `USING` and `WITH CHECK`. Without
WITH CHECK, a user can reassign a row'suser_idto another user: - ```sql
- create policy "example" on table_name for update
- to authenticated
- using ( (select auth.uid()) = user_id )
- with check ( (select auth.uid()) = user_id );
- ```
- - `SECURITY DEFINER` functions bypass RLS. A
SECURITY DEFINERfunction runs with its creator's privileges — typically a role withbypassrls(e.g.,postgres). Never addSECURITY DEFINERto resolve a permission error; it silently removes access control without fixing the underlying cause. PreferSECURITY INVOKER. - - `SECURITY DEFINER` functions in `public` are callable by all roles. Postgres grants
EXECUTEtoPUBLICby default for every new function, so anySECURITY DEFINERfunction inpublicis a public API endpoint callable byanonandauthenticated(which inherit fromPUBLIC) without any additional grant. WhenSECURITY DEFINERis genuinely needed (e.g., bypassing RLS on an internal lookup table), keep the function in a non-exposed schema, always include anauth.uid()check in the function body, and runsupabase db advisorsafter making changes.
- Storage access control
- - Storage upsert requires INSERT + SELECT + UPDATE. Granting only INSERT allows new uploads but file replacement (upsert) silently fails. You need all three.
- Dependency and supply-chain security
- - Always pin package versions and commit lockfiles when installing Supabase packages (
supabase-js,@supabase/ssr,supabase-py, etc.). See the npm security guide for the full checklist.
For any security concern not covered above, fetch the Supabase product security index: https://supabase.com/docs/guides/security/product-security.md
Supabase CLI
Always discover commands via --help — never guess. The CLI structure changes between versions.
supabase --help # All top-level commands
supabase <group> --help # Subcommands (e.g., supabase db --help)
supabase <group> <command> --help # Flags for a specific commandSupabase CLI Known gotchas:
supabase db queryrequires CLI v2.79.0+ → use MCPexecute_sqlorpsqlas fallbacksupabase db advisorsrequires CLI v2.81.3+ → use MCPget_advisorsas fallback- The browser flow of
supabase logincreates a classic token with full account access. In CI, setSUPABASE_ACCESS_TOKENto a scoped personal access token instead. It takes precedence over any saved login. Commands that connect with the database password (--passwordorSUPABASE_DB_PASSWORD, for examplesupabase db push) aren't limited by the token's permissions. - In imperative migration projects, create new hand-authored migration files with
supabase migration new <name>first. Never invent a migration filename or rely on memory for the expected format. Declarative schema projects generate migrations fromsupabase/schemas/; see "Making and Committing Schema Changes" below.
Version check and upgrade: Run supabase --version to check. For CLI changelogs and version-specific features, consult the CLI documentation or GitHub releases.
Supabase MCP Server
For setup instructions, server URL, and configuration, see the MCP setup guide.
Troubleshooting connection issues — follow these steps in order:
- Check if the server is reachable:
-
curl -so /dev/null -w "%{http_code}" https://mcp.supabase.com/mcp - A
401is expected (no token) and means the server is up. Timeout or "connection refused" means it may be down.
- Check `.mcp.json` configuration:
- Verify the project root has a valid
.mcp.jsonwith the correct server URL. If missing, create one pointing tohttps://mcp.supabase.com/mcp.
- Authenticate the MCP server:
- If the server is reachable and
.mcp.jsonis correct but tools aren't visible, the user needs to authenticate. The Supabase MCP server uses OAuth 2.1 — tell the user to trigger the auth flow in their agent, complete it in the browser, and reload the session. - In CI or other environments where the browser flow can't run, pass a scoped personal access token in the
Authorization: Bearerheader instead.
- Check scoped token permissions:
- If a tool fails with "You do not have permission to perform this action" while using a scoped personal access token, the token lacks that tool's permission or the project is outside the token's scope. Check the tool's required permission in the personal access tokens guide.
Supabase Documentation
Before implementing any Supabase feature, find the relevant documentation. Use these methods in priority order:
- MCP `search_docs` tool (preferred — returns relevant snippets directly)
- Fetch docs pages as markdown — any docs page can be fetched by appending
.mdto the URL path. - Web search for Supabase-specific topics when you don't know which page to look at.
Making and Committing Schema Changes
First decide which schema workflow the project uses.
Option A: Declarative schemas
Use this when supabase/schemas/ exists or config.toml sets schema_paths. Edit the desired schema state in those files, then generate and review the migration. Do not start by hand-writing a migration. See the Declarative database schemas guide.
Option B: Imperative migrations
Use this when the project does not use declarative schemas.
To make schema changes, use `execute_sql` (MCP) or `supabase db query` (CLI). These run SQL directly on the database without creating migration history entries, so you can iterate freely and generate a clean migration when ready.
Do NOT use apply_migration to change a local database schema — it writes a migration history entry on every call, which means you can't iterate, and supabase db diff / supabase db pull will produce empty or conflicting diffs. If you use it, you'll be stuck with whatever SQL you passed on the first try.
When ready to commit your changes to a migration file:
- Run advisors →
supabase db advisors(CLI v2.81.3+) or MCPget_advisors. Fix any issues. - Review the Security Checklist above if your changes involve views, functions, triggers, or storage.
- Generate the migration →
supabase db pull <descriptive-name> --local --yes - Verify →
supabase migration list --local
Debugging
When you get an error on a Supabase-related request, for example an error code from the Supabase REST API, Postgres database, or PostgREST, an empty result, getting blocked by RLS unexpectedly, or an error from a Supabase service like Auth, Realtime, Edge Functions, or Storage, you must fetch Supabase's Monitoring and Debugging documentation before diagnosing or proposing a fix, rather than working from memory. The same docs also cover performance optimizations, such as slow queries and missing indexes.
Reference Guides
- Skill Feedback → references/skill-feedback.md
- MUST read when the user reports that this skill gave incorrect guidance or is missing information.
Subgroup 2: Bulletproof RLS & Security Traps
Critical Security Checklist Summary
- Never use `user_metadata` claims in JWT authorization: raw_user_meta_data is user-editable. Always store authorization data in app_metadata.
- `TO authenticated` alone is authentication without authorization: Always combine TO authenticated with an ownership predicate in USING ((select auth.uid()) = user_id).
- UPDATE requires both `USING` and `WITH CHECK`: Without WITH CHECK, a user can reassign a row's user_id to another user.
- Views bypass RLS by default: In Postgres 15+, always declare CREATE VIEW ... WITH (security_invoker = true).
- `SECURITY DEFINER` functions bypass RLS: Never add SECURITY DEFINER to fix a permission error. Prefer SECURITY INVOKER.
- Storage upsert requires INSERT + SELECT + UPDATE: File replacement silently fails if any of these three is missing.
Subgroup 3: CLI, MCP Server & Declarative Migrations
CLI Quick Reference
bash
supabase --help # All top-level commands
supabase db --help # Database subcommands
supabase db advisors # Run automated database security and performance advisors
supabase db query # Execute ad-hoc SQL query (CLI v2.79.0+)
supabase db pull <name> --local # Generate clean migration from local diff
MCP Server Integration
Connect to the official Supabase MCP Server:
``json
{
"mcpServers": {
"supabase": {
"url": "https://mcp.supabase.com/mcp"
}
}
}
Subgroup 4: Postgres Query Performance & Indexing
Supabase Postgres Best Practices
Comprehensive performance optimization guide for Postgres, maintained by Supabase. Contains rules across 8 categories, prioritized by impact to guide automated query optimization and schema design.
When to Apply
Reference these guidelines when:
- Writing SQL queries or designing schemas
- Implementing indexes or query optimization
- Reviewing database performance issues
- Configuring connection pooling or scaling
- Optimizing for Postgres-specific features
- Working with Row-Level Security (RLS)
Rule Categories by Priority
| Priority | Category | Impact | Prefix |
|---|---|---|---|
| 1 | Query Performance | CRITICAL | query- |
| 2 | Connection Management | CRITICAL | conn- |
| 3 | Security & RLS | CRITICAL | security- |
| 4 | Schema Design | HIGH | schema- |
| 5 | Concurrency & Locking | MEDIUM-HIGH | lock- |
| 6 | Data Access Patterns | MEDIUM | data- |
| 7 | Monitoring & Diagnostics | LOW-MEDIUM | monitor- |
| 8 | Advanced Features | LOW | advanced- |
How to Use
Read individual rule files for detailed explanations and SQL examples:
references/query-missing-indexes.md
references/query-partial-indexes.md
references/_sections.mdEach rule file contains:
- Brief explanation of why it matters
- Incorrect SQL example with explanation
- Correct SQL example with explanation
- Optional EXPLAIN output or metrics
- Additional context and references
- Supabase-specific notes (when applicable)
References
- https://www.postgresql.org/docs/current/
- https://supabase.com/docs
- https://wiki.postgresql.org/wiki/Performance_Optimization
- https://supabase.com/docs/guides/database/overview
- https://supabase.com/docs/guides/auth/row-level-security
Subgroup 5: Connection Pooling & Concurrency Locking
Connection Management & PgBouncer
- Pool Modes: Use Transaction mode (port 6543) for serverless and edge environments (Next.js API routes, Vercel, Cloudflare Workers). Use Session mode (port 5432) only when prepared statements or LISTEN/NOTIFY are required.
- Connection Exhaustion: Avoid spawning raw database connections per request in serverless functions.
- Explicit Locks: Avoid LOCK TABLE in production transactions. Prefer fine-grained row locks (FOR UPDATE SKIP LOCKED) for job queues.
Subgroup 6: Monitoring, Diagnostics & Storage Access
Logs Explorer & Error Diagnostics
- Logs Explorer: Query ClickHouse logs directly in the Supabase Dashboard to diagnose edge function crashes, database timeouts, and PostgREST schema cache misses.
- Advisors Engine: Run supabase db advisors to detect missing foreign key indexes, unindexed queries, and permissive RLS policies.
- Storage Buckets: Always verify bucket public/private flags and enforce fine-grained storage RLS policies on the storage.objects table.