// Use when reviewing a proposed REST or GraphQL API change before merge — checks contract clarity, backwards compatibility, errors, pagination, auth, and naming.
| name | api-design-reviewer |
| description | Use when reviewing a proposed REST or GraphQL API change before merge — checks contract clarity, backwards compatibility, errors, pagination, auth, and naming. |
| version | 0.1.0 |
| status | experimental |
| risk | low |
| tags | ["engineering","read-only","writes-files"] |
repo-auditor)| Name | Type | Required | Notes |
|---|---|---|---|
spec | path or text | yes | OpenAPI / GraphQL SDL / Markdown design doc |
mode | "public" | "internal" | no | Default internal. public raises the bar on backwards-compat. |
A Markdown review with sections: Critical, Important, Nits, Open questions.
references/api-review-checklist.md:
GET /users returns an unbounded list. Add cursor pagination (suggested: ?cursor=...&limit=...)."Use when capturing an architecture decision so it survives turnover — produces an ADR-NNNN.md from context, options considered, and the chosen path.
Use when first encountering a new dataset — produces a structured profile (schema, missingness, distributions, outliers, gotchas) before any analysis.
Use after an incident is resolved — drafts a blameless postmortem from timeline notes, alerts, and chat threads.
Use when opening a PR — produces a clean PR description (what / why / how to verify / risks) from a branch diff against base.
Use when planning the next sprint — turns ticket intake + team capacity into a planned sprint with explicit non-goals.
Use after a session to promote useful episodic notes from logs/episodic/ into distilled, dated entries in MEMORY.md and memory/semantic/.