nextjs-hackathon-stack 0.1.40 → 0.1.42

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (174) hide show
  1. package/dist/index.js +3 -63
  2. package/package.json +1 -1
  3. package/template/.claude/agents/backend.md +54 -0
  4. package/template/.claude/agents/business-analyst.md +195 -0
  5. package/template/.claude/agents/code-reviewer.md +76 -0
  6. package/template/.claude/agents/frontend.md +85 -0
  7. package/template/.claude/agents/security-researcher.md +54 -0
  8. package/template/.claude/agents/technical-lead.md +92 -0
  9. package/template/.claude/agents/test-qa.md +85 -0
  10. package/template/.claude/rules/architecture.mdc +48 -0
  11. package/template/.claude/rules/coding-standards.mdc +120 -0
  12. package/template/.claude/rules/components.mdc +49 -0
  13. package/template/.claude/rules/data-fetching.mdc +115 -0
  14. package/template/.claude/rules/forms.mdc +100 -0
  15. package/template/.claude/rules/general.mdc +54 -0
  16. package/template/.claude/rules/migrations.mdc +11 -0
  17. package/template/.claude/rules/nextjs.mdc +71 -0
  18. package/template/.claude/rules/security.mdc +108 -0
  19. package/template/.claude/rules/supabase.mdc +70 -0
  20. package/template/.claude/rules/testing.mdc +136 -0
  21. package/template/.claude/settings.json +16 -0
  22. package/template/.claude/skills/build-feature/SKILL.md +198 -0
  23. package/template/.claude/skills/build-feature/references/server-action-test-template.md +103 -0
  24. package/template/.claude/skills/create-api-route/SKILL.md +62 -0
  25. package/template/.claude/skills/discover-feature/SKILL.md +200 -0
  26. package/template/.claude/skills/memory/SKILL.md +208 -0
  27. package/template/.claude/skills/review-branch/SKILL.md +43 -0
  28. package/template/.claude/skills/review-branch/references/review-checklist.md +36 -0
  29. package/template/.claude/skills/security-audit/SKILL.md +40 -0
  30. package/template/.claude/skills/security-audit/references/audit-steps.md +41 -0
  31. package/template/.claude/skills/supabase/SKILL.md +105 -0
  32. package/template/.claude/skills/supabase/assets/feedback-issue-template.md +17 -0
  33. package/template/.claude/skills/supabase/references/skill-feedback.md +17 -0
  34. package/template/.claude/skills/supabase-postgres-best-practices/SKILL.md +65 -0
  35. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp__contributing.md +170 -0
  36. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp__sections.md +39 -0
  37. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp__template.md +34 -0
  38. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_advanced-full-text-search.md +55 -0
  39. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_advanced-jsonb-indexing.md +49 -0
  40. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_conn-idle-timeout.md +46 -0
  41. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_conn-limits.md +44 -0
  42. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_conn-pooling.md +41 -0
  43. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_conn-prepared-statements.md +46 -0
  44. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_data-batch-inserts.md +54 -0
  45. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_data-n-plus-one.md +53 -0
  46. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_data-pagination.md +50 -0
  47. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_data-upsert.md +50 -0
  48. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_lock-advisory.md +56 -0
  49. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_lock-deadlock-prevention.md +68 -0
  50. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_lock-short-transactions.md +50 -0
  51. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_lock-skip-locked.md +54 -0
  52. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_monitor-explain-analyze.md +45 -0
  53. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_monitor-pg-stat-statements.md +55 -0
  54. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_monitor-vacuum-analyze.md +55 -0
  55. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_query-composite-indexes.md +44 -0
  56. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_query-covering-indexes.md +40 -0
  57. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_query-index-types.md +48 -0
  58. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_query-missing-indexes.md +43 -0
  59. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_query-partial-indexes.md +45 -0
  60. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_schema-constraints.md +80 -0
  61. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_schema-data-types.md +46 -0
  62. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_schema-foreign-key-indexes.md +59 -0
  63. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_schema-lowercase-identifiers.md +55 -0
  64. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_schema-partitioning.md +55 -0
  65. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_schema-primary-keys.md +61 -0
  66. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_security-privileges.md +54 -0
  67. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_security-rls-basics.md +50 -0
  68. package/template/.claude/skills/supabase-postgres-best-practices/references/pgbp_security-rls-performance.md +57 -0
  69. package/template/.cursor/agents/business-analyst.md +197 -0
  70. package/template/.cursor/agents/technical-lead.md +3 -3
  71. package/template/.cursor/mcp.json +6 -2
  72. package/template/.cursor/skills/build-feature/SKILL.md +20 -21
  73. package/template/.cursor/skills/discover-feature/SKILL.md +118 -29
  74. package/template/.cursor/skills/supabase/SKILL.md +104 -0
  75. package/template/.cursor/skills/supabase/assets/feedback-issue-template.md +17 -0
  76. package/template/.cursor/skills/supabase/references/skill-feedback.md +17 -0
  77. package/template/.cursor/skills/supabase-postgres-best-practices/SKILL.md +64 -0
  78. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp__contributing.md +170 -0
  79. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp__sections.md +39 -0
  80. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp__template.md +34 -0
  81. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_advanced-full-text-search.md +55 -0
  82. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_advanced-jsonb-indexing.md +49 -0
  83. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_conn-idle-timeout.md +46 -0
  84. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_conn-limits.md +44 -0
  85. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_conn-pooling.md +41 -0
  86. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_conn-prepared-statements.md +46 -0
  87. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_data-batch-inserts.md +54 -0
  88. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_data-n-plus-one.md +53 -0
  89. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_data-pagination.md +50 -0
  90. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_data-upsert.md +50 -0
  91. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_lock-advisory.md +56 -0
  92. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_lock-deadlock-prevention.md +68 -0
  93. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_lock-short-transactions.md +50 -0
  94. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_lock-skip-locked.md +54 -0
  95. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_monitor-explain-analyze.md +45 -0
  96. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_monitor-pg-stat-statements.md +55 -0
  97. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_monitor-vacuum-analyze.md +55 -0
  98. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_query-composite-indexes.md +44 -0
  99. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_query-covering-indexes.md +40 -0
  100. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_query-index-types.md +48 -0
  101. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_query-missing-indexes.md +43 -0
  102. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_query-partial-indexes.md +45 -0
  103. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_schema-constraints.md +80 -0
  104. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_schema-data-types.md +46 -0
  105. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_schema-foreign-key-indexes.md +59 -0
  106. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_schema-lowercase-identifiers.md +55 -0
  107. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_schema-partitioning.md +55 -0
  108. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_schema-primary-keys.md +61 -0
  109. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_security-privileges.md +54 -0
  110. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_security-rls-basics.md +50 -0
  111. package/template/.cursor/skills/supabase-postgres-best-practices/references/pgbp_security-rls-performance.md +57 -0
  112. package/template/.mcp.json +16 -0
  113. package/template/.opencode/agents/backend.md +72 -0
  114. package/template/.opencode/agents/business-analyst.md +153 -0
  115. package/template/.opencode/agents/code-reviewer.md +80 -0
  116. package/template/.opencode/agents/frontend.md +84 -0
  117. package/template/.opencode/agents/security-researcher.md +58 -0
  118. package/template/.opencode/agents/technical-lead.md +131 -0
  119. package/template/.opencode/agents/test-qa.md +103 -0
  120. package/template/.opencode/memory/architecture-snapshot.md +127 -0
  121. package/template/.opencode/skills/build-feature/SKILL.md +208 -0
  122. package/template/.opencode/skills/create-api-route/SKILL.md +63 -0
  123. package/template/.opencode/skills/discover-feature/SKILL.md +194 -0
  124. package/template/.opencode/skills/memory/SKILL.md +199 -0
  125. package/template/.opencode/skills/review-branch/SKILL.md +43 -0
  126. package/template/.opencode/skills/security-audit/SKILL.md +40 -0
  127. package/template/.opencode/skills/supabase/SKILL.md +105 -0
  128. package/template/.opencode/skills/supabase/assets/feedback-issue-template.md +17 -0
  129. package/template/.opencode/skills/supabase/references/skill-feedback.md +17 -0
  130. package/template/.opencode/skills/supabase-postgres-best-practices/SKILL.md +65 -0
  131. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp__contributing.md +170 -0
  132. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp__sections.md +39 -0
  133. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp__template.md +34 -0
  134. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_advanced-full-text-search.md +55 -0
  135. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_advanced-jsonb-indexing.md +49 -0
  136. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_conn-idle-timeout.md +46 -0
  137. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_conn-limits.md +44 -0
  138. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_conn-pooling.md +41 -0
  139. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_conn-prepared-statements.md +46 -0
  140. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_data-batch-inserts.md +54 -0
  141. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_data-n-plus-one.md +53 -0
  142. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_data-pagination.md +50 -0
  143. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_data-upsert.md +50 -0
  144. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_lock-advisory.md +56 -0
  145. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_lock-deadlock-prevention.md +68 -0
  146. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_lock-short-transactions.md +50 -0
  147. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_lock-skip-locked.md +54 -0
  148. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_monitor-explain-analyze.md +45 -0
  149. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_monitor-pg-stat-statements.md +55 -0
  150. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_monitor-vacuum-analyze.md +55 -0
  151. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_query-composite-indexes.md +44 -0
  152. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_query-covering-indexes.md +40 -0
  153. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_query-index-types.md +48 -0
  154. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_query-missing-indexes.md +43 -0
  155. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_query-partial-indexes.md +45 -0
  156. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_schema-constraints.md +80 -0
  157. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_schema-data-types.md +46 -0
  158. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_schema-foreign-key-indexes.md +59 -0
  159. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_schema-lowercase-identifiers.md +55 -0
  160. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_schema-partitioning.md +55 -0
  161. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_schema-primary-keys.md +61 -0
  162. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_security-privileges.md +54 -0
  163. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_security-rls-basics.md +50 -0
  164. package/template/.opencode/skills/supabase-postgres-best-practices/references/pgbp_security-rls-performance.md +57 -0
  165. package/template/.requirements/README.md +1 -1
  166. package/template/AGENTS.md +1 -1
  167. package/template/CLAUDE.md +1 -1
  168. package/template/Dockerfile.memory +7 -0
  169. package/template/README.md +15 -2
  170. package/template/_gitignore +3 -0
  171. package/template/docker-compose.yml +28 -0
  172. package/template/ia-flow.md +341 -0
  173. package/template/opencode.json +23 -0
  174. package/template/.cursor/agents/business-intelligence.md +0 -83
@@ -0,0 +1,104 @@
1
+ ---
2
+ name: supabase
3
+ description: "Use when doing ANY task involving Supabase. Triggers: Supabase products (Database, Auth, Edge Functions, Realtime, Storage, Vectors, Cron, Queues); client libraries and SSR integrations (supabase-js, @supabase/ssr) in Next.js, React, SvelteKit, Astro, Remix; auth issues (login, logout, sessions, JWT, cookies, getSession, getUser, getClaims, RLS); Supabase CLI or MCP server; schema changes, migrations, security audits, Postgres extensions (pg_graphql, pg_cron, pg_vector)."
4
+ metadata:
5
+ author: supabase
6
+ version: "0.1.0"
7
+ ---
8
+
9
+ # Supabase
10
+
11
+ ## Core Principles
12
+
13
+ **1. Supabase changes frequently — verify against current docs before implementing.**
14
+ Do not rely on training data for Supabase features. Function signatures, config.toml settings, and API conventions change between versions. Before implementing, look up the relevant topic using the documentation access methods below.
15
+
16
+ **2. Verify your work.**
17
+ After implementing any fix, run a test query to confirm the change works. A fix without verification is incomplete.
18
+
19
+ **3. Recover from errors, don't loop.**
20
+ 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.
21
+
22
+ **4. RLS by default in exposed schemas.**
23
+ Enable RLS on every table in any exposed schema, especially `public`. This is critical in Supabase because tables in exposed schemas can be reachable through 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.
24
+
25
+ **5. Security checklist.**
26
+ 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:
27
+
28
+ - **Auth and session security**
29
+ - **Never use `user_metadata` claims in JWT-based authorization decisions.** In Supabase, `raw_user_meta_data` is user-editable and can appear in `auth.jwt()`, so it is unsafe for RLS policies or any other authorization logic. Store authorization data in `raw_app_meta_data` / `app_metadata` instead.
30
+ - **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_id` against `auth.sessions` on sensitive operations.
31
+ - **If you use `app_metadata` or `auth.jwt()` for authorization, remember JWT claims are not always fresh until the user's token is refreshed.**
32
+
33
+ - **API key and client exposure**
34
+ - **Never expose the `service_role` or secret key in public clients.** Prefer publishable keys for frontend code. Legacy `anon` keys are only for compatibility. In Next.js, any `NEXT_PUBLIC_` env var is sent to the browser.
35
+
36
+ - **RLS, views, and privileged database code**
37
+ - **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 the `anon` and `authenticated` roles, or by putting them in an unexposed schema.
38
+ - **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.
39
+ - **Do not put `security definer` functions in an exposed schema.** Keep them in a private or otherwise unexposed schema.
40
+
41
+
42
+ - **Storage access control**
43
+ - **Storage upsert requires INSERT + SELECT + UPDATE.** Granting only INSERT allows new uploads but file replacement (upsert) silently fails. You need all three.
44
+
45
+ For any security concern not covered above, fetch the Supabase product security index: `https://supabase.com/docs/guides/security/product-security.md`
46
+
47
+ ## Supabase CLI
48
+
49
+ Always discover commands via `--help` — never guess. The CLI structure changes between versions.
50
+
51
+ ```bash
52
+ supabase --help # All top-level commands
53
+ supabase <group> --help # Subcommands (e.g., supabase db --help)
54
+ supabase <group> <command> --help # Flags for a specific command
55
+ ```
56
+
57
+ **Supabase CLI Known gotchas:**
58
+ - `supabase db query` requires **CLI v2.79.0+** → use MCP `execute_sql` or `psql` as fallback
59
+ - `supabase db advisors` requires **CLI v2.81.3+** → use MCP `get_advisors` as fallback
60
+ - When you need a new migration SQL file, **always** create it with `supabase migration new <name>` first. Never invent a migration filename or rely on memory for the expected format.
61
+
62
+ **Version check and upgrade:** Run `supabase --version` to check. For CLI changelogs and version-specific features, consult the [CLI documentation](https://supabase.com/docs/reference/cli/introduction) or [GitHub releases](https://github.com/supabase/cli/releases).
63
+
64
+ ## Supabase MCP Server
65
+
66
+ For setup instructions, server URL, and configuration, see the [MCP setup guide](https://supabase.com/docs/guides/getting-started/mcp).
67
+
68
+ **Troubleshooting connection issues** — follow these steps in order:
69
+
70
+ 1. **Check if the server is reachable:**
71
+ `curl -so /dev/null -w "%{http_code}" https://mcp.supabase.com/mcp`
72
+ A `401` is expected (no token) and means the server is up. Timeout or "connection refused" means it may be down.
73
+
74
+ 2. **Check `.mcp.json` configuration:**
75
+ Verify the project root has a valid `.mcp.json` with the correct server URL. If missing, create one pointing to `https://mcp.supabase.com/mcp`.
76
+
77
+ 3. **Authenticate the MCP server:**
78
+ If the server is reachable and `.mcp.json` is 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.
79
+
80
+ ## Supabase Documentation
81
+
82
+ Before implementing any Supabase feature, find the relevant documentation. Use these methods in priority order:
83
+
84
+ 1. **MCP `search_docs` tool** (preferred — returns relevant snippets directly)
85
+ 2. **Fetch docs pages as markdown** — any docs page can be fetched by appending `.md` to the URL path.
86
+ 3. **Web search** for Supabase-specific topics when you don't know which page to look at.
87
+
88
+ ## Making and Committing Schema Changes
89
+
90
+ **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.
91
+
92
+ 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.
93
+
94
+ **When ready to commit** your changes to a migration file:
95
+
96
+ 1. **Run advisors** → `supabase db advisors` (CLI v2.81.3+) or MCP `get_advisors`. Fix any issues.
97
+ 2. **Review the Security Checklist above** if your changes involve views, functions, triggers, or storage.
98
+ 3. **Generate the migration** → `supabase db pull <descriptive-name> --local --yes`
99
+ 4. **Verify** → `supabase migration list --local`
100
+
101
+ ## Reference Guides
102
+
103
+ - **Skill Feedback** → [references/skill-feedback.md](references/skill-feedback.md)
104
+ **MUST read when** the user reports that this skill gave incorrect guidance or is missing information.
@@ -0,0 +1,17 @@
1
+ ## What happened
2
+
3
+ **Task:** <!-- e.g., "Set up MFA on patient records" -->
4
+
5
+ **Skill said:** <!-- e.g., "Use auth.jwt()->>'app_metadata' in the RLS policy" -->
6
+
7
+ **Expected:** <!-- e.g., "The function also needs SECURITY DEFINER + grant to supabase_auth_admin" -->
8
+
9
+ ## Source
10
+
11
+ **File:** <!-- e.g., references/security-model.md -->
12
+
13
+ **Section:** <!-- e.g., "Trust Boundaries > user_metadata vs app_metadata" -->
14
+
15
+ ## Fix suggestion
16
+
17
+ <!-- Leave blank if unsure -->
@@ -0,0 +1,17 @@
1
+ # Skill Feedback
2
+
3
+ Use this when the user reports that the skill gave incorrect guidance, is missing information, or could be improved. This is about the skill (agent instructions), not about Supabase the product.
4
+
5
+ ## Steps
6
+
7
+ 1. **Ask permission** — Ask the user if they'd like to submit feedback to the skill maintainers. If they decline, move on.
8
+
9
+ 2. **Draft the issue** — Use the template at [assets/feedback-issue-template.md](../assets/feedback-issue-template.md) to structure the feedback. Fill in the fields based on the conversation. Always identify which specific reference file and section caused the problem.
10
+
11
+ 3. **Submit** — Create a GitHub Issue on the `supabase/agent-skills` repository using the draft as the issue body. The title must follow this format: `user-feedback: <summary of the problem>`.
12
+
13
+ 4. **Share the result** — Share the issue URL with the user after submission. If submission fails, give the user this link to create the issue manually:
14
+
15
+ ```
16
+ https://github.com/supabase/agent-skills/issues/new
17
+ ```
@@ -0,0 +1,64 @@
1
+ ---
2
+ name: supabase-postgres-best-practices
3
+ description: Postgres performance optimization and best practices from Supabase. Use this skill when writing, reviewing, or optimizing Postgres queries, schema designs, or database configurations.
4
+ license: MIT
5
+ metadata:
6
+ author: supabase
7
+ version: "1.1.1"
8
+ organization: Supabase
9
+ date: January 2026
10
+ abstract: Comprehensive Postgres performance optimization guide for developers using Supabase and Postgres. Contains performance rules across 8 categories, prioritized by impact from critical (query performance, connection management) to incremental (advanced features). Each rule includes detailed explanations, incorrect vs. correct SQL examples, query plan analysis, and specific performance metrics to guide automated optimization and code generation.
11
+ ---
12
+
13
+ # Supabase Postgres Best Practices
14
+
15
+ 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.
16
+
17
+ ## When to Apply
18
+
19
+ Reference these guidelines when:
20
+ - Writing SQL queries or designing schemas
21
+ - Implementing indexes or query optimization
22
+ - Reviewing database performance issues
23
+ - Configuring connection pooling or scaling
24
+ - Optimizing for Postgres-specific features
25
+ - Working with Row-Level Security (RLS)
26
+
27
+ ## Rule Categories by Priority
28
+
29
+ | Priority | Category | Impact | Prefix |
30
+ |----------|----------|--------|--------|
31
+ | 1 | Query Performance | CRITICAL | `query-` |
32
+ | 2 | Connection Management | CRITICAL | `conn-` |
33
+ | 3 | Security & RLS | CRITICAL | `security-` |
34
+ | 4 | Schema Design | HIGH | `schema-` |
35
+ | 5 | Concurrency & Locking | MEDIUM-HIGH | `lock-` |
36
+ | 6 | Data Access Patterns | MEDIUM | `data-` |
37
+ | 7 | Monitoring & Diagnostics | LOW-MEDIUM | `monitor-` |
38
+ | 8 | Advanced Features | LOW | `advanced-` |
39
+
40
+ ## How to Use
41
+
42
+ Read individual rule files for detailed explanations and SQL examples:
43
+
44
+ ```
45
+ references/query-missing-indexes.md
46
+ references/query-partial-indexes.md
47
+ references/_sections.md
48
+ ```
49
+
50
+ Each rule file contains:
51
+ - Brief explanation of why it matters
52
+ - Incorrect SQL example with explanation
53
+ - Correct SQL example with explanation
54
+ - Optional EXPLAIN output or metrics
55
+ - Additional context and references
56
+ - Supabase-specific notes (when applicable)
57
+
58
+ ## References
59
+
60
+ - https://www.postgresql.org/docs/current/
61
+ - https://supabase.com/docs
62
+ - https://wiki.postgresql.org/wiki/Performance_Optimization
63
+ - https://supabase.com/docs/guides/database/overview
64
+ - https://supabase.com/docs/guides/auth/row-level-security
@@ -0,0 +1,170 @@
1
+ # Writing Guidelines for Postgres References
2
+
3
+ This document provides guidelines for creating effective Postgres best
4
+ practice references that work well with AI agents and LLMs.
5
+
6
+ ## Key Principles
7
+
8
+ ### 1. Concrete Transformation Patterns
9
+
10
+ Show exact SQL rewrites. Avoid philosophical advice.
11
+
12
+ **Good:** "Use `WHERE id = ANY(ARRAY[...])` instead of
13
+ `WHERE id IN (SELECT ...)`" **Bad:** "Design good schemas"
14
+
15
+ ### 2. Error-First Structure
16
+
17
+ Always show the problematic pattern first, then the solution. This trains agents
18
+ to recognize anti-patterns.
19
+
20
+ ```markdown
21
+ **Incorrect (sequential queries):** [bad example]
22
+
23
+ **Correct (batched query):** [good example]
24
+ ```
25
+
26
+ ### 3. Quantified Impact
27
+
28
+ Include specific metrics. Helps agents prioritize fixes.
29
+
30
+ **Good:** "10x faster queries", "50% smaller index", "Eliminates N+1"
31
+ **Bad:** "Faster", "Better", "More efficient"
32
+
33
+ ### 4. Self-Contained Examples
34
+
35
+ Examples should be complete and runnable (or close to it). Include `CREATE TABLE`
36
+ if context is needed.
37
+
38
+ ```sql
39
+ -- Include table definition when needed for clarity
40
+ CREATE TABLE users (
41
+ id bigint PRIMARY KEY,
42
+ email text NOT NULL,
43
+ deleted_at timestamptz
44
+ );
45
+
46
+ -- Now show the index
47
+ CREATE INDEX users_active_email_idx ON users(email) WHERE deleted_at IS NULL;
48
+ ```
49
+
50
+ ### 5. Semantic Naming
51
+
52
+ Use meaningful table/column names. Names carry intent for LLMs.
53
+
54
+ **Good:** `users`, `email`, `created_at`, `is_active`
55
+ **Bad:** `table1`, `col1`, `field`, `flag`
56
+
57
+ ---
58
+
59
+ ## Code Example Standards
60
+
61
+ ### SQL Formatting
62
+
63
+ ```sql
64
+ -- Use lowercase keywords, clear formatting
65
+ CREATE INDEX CONCURRENTLY users_email_idx
66
+ ON users(email)
67
+ WHERE deleted_at IS NULL;
68
+
69
+ -- Not cramped or ALL CAPS
70
+ CREATE INDEX CONCURRENTLY USERS_EMAIL_IDX ON USERS(EMAIL) WHERE DELETED_AT IS NULL;
71
+ ```
72
+
73
+ ### Comments
74
+
75
+ - Explain _why_, not _what_
76
+ - Highlight performance implications
77
+ - Point out common pitfalls
78
+
79
+ ### Language Tags
80
+
81
+ - `sql` - Standard SQL queries
82
+ - `plpgsql` - Stored procedures/functions
83
+ - `typescript` - Application code (when needed)
84
+ - `python` - Application code (when needed)
85
+
86
+ ---
87
+
88
+ ## When to Include Application Code
89
+
90
+ **Default: SQL Only**
91
+
92
+ Most references should focus on pure SQL patterns. This keeps examples portable.
93
+
94
+ **Include Application Code When:**
95
+
96
+ - Connection pooling configuration
97
+ - Transaction management in application context
98
+ - ORM anti-patterns (N+1 in Prisma/TypeORM)
99
+ - Prepared statement usage
100
+
101
+ **Format for Mixed Examples:**
102
+
103
+ ````markdown
104
+ **Incorrect (N+1 in application):**
105
+
106
+ ```typescript
107
+ for (const user of users) {
108
+ const posts = await db.query("SELECT * FROM posts WHERE user_id = $1", [
109
+ user.id,
110
+ ]);
111
+ }
112
+ ```
113
+ ````
114
+
115
+ **Correct (batch query):**
116
+
117
+ ```typescript
118
+ const posts = await db.query("SELECT * FROM posts WHERE user_id = ANY($1)", [
119
+ userIds,
120
+ ]);
121
+ ```
122
+
123
+ ---
124
+
125
+ ## Impact Level Guidelines
126
+
127
+ | Level | Improvement | Use When |
128
+ |-------|-------------|----------|
129
+ | **CRITICAL** | 10-100x | Missing indexes, connection exhaustion, sequential scans on large tables |
130
+ | **HIGH** | 5-20x | Wrong index types, poor partitioning, missing covering indexes |
131
+ | **MEDIUM-HIGH** | 2-5x | N+1 queries, inefficient pagination, RLS optimization |
132
+ | **MEDIUM** | 1.5-3x | Redundant indexes, query plan instability |
133
+ | **LOW-MEDIUM** | 1.2-2x | VACUUM tuning, configuration tweaks |
134
+ | **LOW** | Incremental | Advanced patterns, edge cases |
135
+
136
+ ---
137
+
138
+ ## Reference Standards
139
+
140
+ **Primary Sources:**
141
+
142
+ - Official Postgres documentation
143
+ - Supabase documentation
144
+ - Postgres wiki
145
+ - Established blogs (2ndQuadrant, Crunchy Data)
146
+
147
+ **Format:**
148
+
149
+ ```markdown
150
+ Reference:
151
+ [Postgres Indexes](https://www.postgresql.org/docs/current/indexes.html)
152
+ ```
153
+
154
+ ---
155
+
156
+ ## Review Checklist
157
+
158
+ Before submitting a reference:
159
+
160
+ - [ ] Title is clear and action-oriented
161
+ - [ ] Impact level matches the performance gain
162
+ - [ ] impactDescription includes quantification
163
+ - [ ] Explanation is concise (1-2 sentences)
164
+ - [ ] Has at least 1 **Incorrect** SQL example
165
+ - [ ] Has at least 1 **Correct** SQL example
166
+ - [ ] SQL uses semantic naming
167
+ - [ ] Comments explain _why_, not _what_
168
+ - [ ] Trade-offs mentioned if applicable
169
+ - [ ] Reference links included
170
+ - [ ] `mise run test` passes
@@ -0,0 +1,39 @@
1
+ # Section Definitions
2
+
3
+ This file defines the rule categories for Postgres best practices. Rules are automatically assigned to sections based on their filename prefix.
4
+
5
+ Take the examples below as pure demonstrative. Replace each section with the actual rule categories for Postgres best practices.
6
+
7
+ ---
8
+
9
+ ## 1. Query Performance (query)
10
+ **Impact:** CRITICAL
11
+ **Description:** Slow queries, missing indexes, inefficient query plans. The most common source of Postgres performance issues.
12
+
13
+ ## 2. Connection Management (conn)
14
+ **Impact:** CRITICAL
15
+ **Description:** Connection pooling, limits, and serverless strategies. Critical for applications with high concurrency or serverless deployments.
16
+
17
+ ## 3. Security & RLS (security)
18
+ **Impact:** CRITICAL
19
+ **Description:** Row-Level Security policies, privilege management, and authentication patterns.
20
+
21
+ ## 4. Schema Design (schema)
22
+ **Impact:** HIGH
23
+ **Description:** Table design, index strategies, partitioning, and data type selection. Foundation for long-term performance.
24
+
25
+ ## 5. Concurrency & Locking (lock)
26
+ **Impact:** MEDIUM-HIGH
27
+ **Description:** Transaction management, isolation levels, deadlock prevention, and lock contention patterns.
28
+
29
+ ## 6. Data Access Patterns (data)
30
+ **Impact:** MEDIUM
31
+ **Description:** N+1 query elimination, batch operations, cursor-based pagination, and efficient data fetching.
32
+
33
+ ## 7. Monitoring & Diagnostics (monitor)
34
+ **Impact:** LOW-MEDIUM
35
+ **Description:** Using pg_stat_statements, EXPLAIN ANALYZE, metrics collection, and performance diagnostics.
36
+
37
+ ## 8. Advanced Features (advanced)
38
+ **Impact:** LOW
39
+ **Description:** Full-text search, JSONB optimization, PostGIS, extensions, and advanced Postgres features.
@@ -0,0 +1,34 @@
1
+ ---
2
+ title: Clear, Action-Oriented Title (e.g., "Use Partial Indexes for Filtered Queries")
3
+ impact: MEDIUM
4
+ impactDescription: 5-20x query speedup for filtered queries
5
+ tags: indexes, query-optimization, performance
6
+ ---
7
+
8
+ ## [Rule Title]
9
+
10
+ [1-2 sentence explanation of the problem and why it matters. Focus on performance impact.]
11
+
12
+ **Incorrect (describe the problem):**
13
+
14
+ ```sql
15
+ -- Comment explaining what makes this slow/problematic
16
+ CREATE INDEX users_email_idx ON users(email);
17
+
18
+ SELECT * FROM users WHERE email = 'user@example.com' AND deleted_at IS NULL;
19
+ -- This scans deleted records unnecessarily
20
+ ```
21
+
22
+ **Correct (describe the solution):**
23
+
24
+ ```sql
25
+ -- Comment explaining why this is better
26
+ CREATE INDEX users_active_email_idx ON users(email) WHERE deleted_at IS NULL;
27
+
28
+ SELECT * FROM users WHERE email = 'user@example.com' AND deleted_at IS NULL;
29
+ -- Only indexes active users, 10x smaller index, faster queries
30
+ ```
31
+
32
+ [Optional: Additional context, edge cases, or trade-offs]
33
+
34
+ Reference: [Postgres Docs](https://www.postgresql.org/docs/current/)
@@ -0,0 +1,55 @@
1
+ ---
2
+ title: Use tsvector for Full-Text Search
3
+ impact: MEDIUM
4
+ impactDescription: 100x faster than LIKE, with ranking support
5
+ tags: full-text-search, tsvector, gin, search
6
+ ---
7
+
8
+ ## Use tsvector for Full-Text Search
9
+
10
+ LIKE with wildcards can't use indexes. Full-text search with tsvector is orders of magnitude faster.
11
+
12
+ **Incorrect (LIKE pattern matching):**
13
+
14
+ ```sql
15
+ -- Cannot use index, scans all rows
16
+ select * from articles where content like '%postgresql%';
17
+
18
+ -- Case-insensitive makes it worse
19
+ select * from articles where lower(content) like '%postgresql%';
20
+ ```
21
+
22
+ **Correct (full-text search with tsvector):**
23
+
24
+ ```sql
25
+ -- Add tsvector column and index
26
+ alter table articles add column search_vector tsvector
27
+ generated always as (to_tsvector('english', coalesce(title,'') || ' ' || coalesce(content,''))) stored;
28
+
29
+ create index articles_search_idx on articles using gin (search_vector);
30
+
31
+ -- Fast full-text search
32
+ select * from articles
33
+ where search_vector @@ to_tsquery('english', 'postgresql & performance');
34
+
35
+ -- With ranking
36
+ select *, ts_rank(search_vector, query) as rank
37
+ from articles, to_tsquery('english', 'postgresql') query
38
+ where search_vector @@ query
39
+ order by rank desc;
40
+ ```
41
+
42
+ Search multiple terms:
43
+
44
+ ```sql
45
+ -- AND: both terms required
46
+ to_tsquery('postgresql & performance')
47
+
48
+ -- OR: either term
49
+ to_tsquery('postgresql | mysql')
50
+
51
+ -- Prefix matching
52
+ to_tsquery('post:*')
53
+ ```
54
+
55
+ Reference: [Full Text Search](https://supabase.com/docs/guides/database/full-text-search)
@@ -0,0 +1,49 @@
1
+ ---
2
+ title: Index JSONB Columns for Efficient Querying
3
+ impact: MEDIUM
4
+ impactDescription: 10-100x faster JSONB queries with proper indexing
5
+ tags: jsonb, gin, indexes, json
6
+ ---
7
+
8
+ ## Index JSONB Columns for Efficient Querying
9
+
10
+ JSONB queries without indexes scan the entire table. Use GIN indexes for containment queries.
11
+
12
+ **Incorrect (no index on JSONB):**
13
+
14
+ ```sql
15
+ create table products (
16
+ id bigint primary key,
17
+ attributes jsonb
18
+ );
19
+
20
+ -- Full table scan for every query
21
+ select * from products where attributes @> '{"color": "red"}';
22
+ select * from products where attributes->>'brand' = 'Nike';
23
+ ```
24
+
25
+ **Correct (GIN index for JSONB):**
26
+
27
+ ```sql
28
+ -- GIN index for containment operators (@>, ?, ?&, ?|)
29
+ create index products_attrs_gin on products using gin (attributes);
30
+
31
+ -- Now containment queries use the index
32
+ select * from products where attributes @> '{"color": "red"}';
33
+
34
+ -- For specific key lookups, use expression index
35
+ create index products_brand_idx on products ((attributes->>'brand'));
36
+ select * from products where attributes->>'brand' = 'Nike';
37
+ ```
38
+
39
+ Choose the right operator class:
40
+
41
+ ```sql
42
+ -- jsonb_ops (default): supports all operators, larger index
43
+ create index idx1 on products using gin (attributes);
44
+
45
+ -- jsonb_path_ops: only @> operator, but 2-3x smaller index
46
+ create index idx2 on products using gin (attributes jsonb_path_ops);
47
+ ```
48
+
49
+ Reference: [JSONB Indexes](https://www.postgresql.org/docs/current/datatype-json.html#JSON-INDEXING)
@@ -0,0 +1,46 @@
1
+ ---
2
+ title: Configure Idle Connection Timeouts
3
+ impact: HIGH
4
+ impactDescription: Reclaim 30-50% of connection slots from idle clients
5
+ tags: connections, timeout, idle, resource-management
6
+ ---
7
+
8
+ ## Configure Idle Connection Timeouts
9
+
10
+ Idle connections waste resources. Configure timeouts to automatically reclaim them.
11
+
12
+ **Incorrect (connections held indefinitely):**
13
+
14
+ ```sql
15
+ -- No timeout configured
16
+ show idle_in_transaction_session_timeout; -- 0 (disabled)
17
+
18
+ -- Connections stay open forever, even when idle
19
+ select pid, state, state_change, query
20
+ from pg_stat_activity
21
+ where state = 'idle in transaction';
22
+ -- Shows transactions idle for hours, holding locks
23
+ ```
24
+
25
+ **Correct (automatic cleanup of idle connections):**
26
+
27
+ ```sql
28
+ -- Terminate connections idle in transaction after 30 seconds
29
+ alter system set idle_in_transaction_session_timeout = '30s';
30
+
31
+ -- Terminate completely idle connections after 10 minutes
32
+ alter system set idle_session_timeout = '10min';
33
+
34
+ -- Reload configuration
35
+ select pg_reload_conf();
36
+ ```
37
+
38
+ For pooled connections, configure at the pooler level:
39
+
40
+ ```ini
41
+ # pgbouncer.ini
42
+ server_idle_timeout = 60
43
+ client_idle_timeout = 300
44
+ ```
45
+
46
+ Reference: [Connection Timeouts](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-IDLE-IN-TRANSACTION-SESSION-TIMEOUT)
@@ -0,0 +1,44 @@
1
+ ---
2
+ title: Set Appropriate Connection Limits
3
+ impact: CRITICAL
4
+ impactDescription: Prevent database crashes and memory exhaustion
5
+ tags: connections, max-connections, limits, stability
6
+ ---
7
+
8
+ ## Set Appropriate Connection Limits
9
+
10
+ Too many connections exhaust memory and degrade performance. Set limits based on available resources.
11
+
12
+ **Incorrect (unlimited or excessive connections):**
13
+
14
+ ```sql
15
+ -- Default max_connections = 100, but often increased blindly
16
+ show max_connections; -- 500 (way too high for 4GB RAM)
17
+
18
+ -- Each connection uses 1-3MB RAM
19
+ -- 500 connections * 2MB = 1GB just for connections!
20
+ -- Out of memory errors under load
21
+ ```
22
+
23
+ **Correct (calculate based on resources):**
24
+
25
+ ```sql
26
+ -- Formula: max_connections = (RAM in MB / 5MB per connection) - reserved
27
+ -- For 4GB RAM: (4096 / 5) - 10 = ~800 theoretical max
28
+ -- But practically, 100-200 is better for query performance
29
+
30
+ -- Recommended settings for 4GB RAM
31
+ alter system set max_connections = 100;
32
+
33
+ -- Also set work_mem appropriately
34
+ -- work_mem * max_connections should not exceed 25% of RAM
35
+ alter system set work_mem = '8MB'; -- 8MB * 100 = 800MB max
36
+ ```
37
+
38
+ Monitor connection usage:
39
+
40
+ ```sql
41
+ select count(*), state from pg_stat_activity group by state;
42
+ ```
43
+
44
+ Reference: [Database Connections](https://supabase.com/docs/guides/platform/performance#connection-management)