Content
75%Weight 40%Scale 1-5Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
A well-organized diagnostic catalog: nearly every section is a concrete, runnable symptom-to-fix pair, the opening triage table aids navigation, and bundle usage is sound. Main weaknesses are the duplicated inline error-code tables, a couple of comment-only or misleading snippets (stale data, health check), and the absence of explicit fix-verification steps.
Suggestions
Remove the inline "Common Error Codes" tables and point that section to references/common-errors.md, which already covers PGRST116/205/301, 23505, 23503, 42501, and more — this eliminates duplication and improves both conciseness and progressive disclosure.
Fix the "Query Returning Stale Data" section: .throwOnError() and { head: false, count: 'exact' } do not bypass caching; replace with an actually effective approach (e.g., a no-op filter or documented cache-busting pattern) or drop the section.
Add a short verification convention after fixes (e.g., 're-run the original failing query to confirm the symptom is resolved') to close the workflow loop, and replace comment-only fixes like the pooling advice with a concrete pooled connection-string example.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is lean — symptom-to-code pairs with terse, purposeful comments ("Normalize email", "Caches auth.uid() result") and no concept explanations — but the ~20-line "Common Error Codes" tables duplicate content already in references/common-errors.md, and the "Query Returning Stale Data" snippets spend tokens without delivering the promised cache bypass. This is 'efficient with minor instances that could be trimmed' (anchor 4) rather than the every-token-earns-its-place level of 5. | 4 / 5 |
Actionability | Most sections give copy-paste-ready guidance (pg_policies/pg_tables RLS inspection, signInWithPassword normalization, upsert with onConflict, EXPLAIN ANALYZE, supabase secrets set), but a few fixes are comment-only hints ("Use transaction mode, not session mode" pooling advice, "Only create one Supabase client per app") and the stale-data and '_health' check snippets are not executable as written. Minor gaps place it at anchor 4, below the fully-executable 5. | 4 / 5 |
Workflow Clarity | The "Quick Diagnosis" symptom-to-cause table provides a coherent triage entry point, and sections embed their own checks ("Test policy with your user ID", logging subscription status, inspecting seq_scan counts). It stays below 5 because there is no explicit verify-the-fix step (e.g., re-run the failing query after applying the fix), and above 3 because checkpoints are largely embedded rather than absent. No destructive/batch-operation cap applies since the guidance is predominantly read-only diagnostics. | 4 / 5 |
Progressive Disclosure | The single reference (references/common-errors.md) is real, one level deep, and clearly signaled at the end of the body with a description of its purpose. However, the inline "Common Error Codes" tables duplicate the reference file's coverage, so content splitting is only mostly appropriate — anchor 4 ('good structure; minor organization gaps') rather than 5's fully appropriate split. | 4 / 5 |
Total | 16 / 20 Passed |