api-design-review SKILL.md skillA
This file is byte-identical to the first copy the registry indexed. Same content hash, so the same checks give both the same grade.
api-design-review from khaledsaeed18/dotclaude is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add khaledsaeed18/dotclaude/api-design-review@git:20260921.b1a4652Pins git:20260921.b1a4652 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- khaledsaeed18/dotclaude
- Path
skills/engineering/api-design-review/SKILL.md- Versions recorded
- 2
- Latest version
- git:20260921.b1a4652, committed Sep 21, 2026
- First version recorded
- Jul 4, 2026
- Size
- 4,396 bytes
- Repository stars
- 5
- License
- MIT
Review an API contract (REST or GraphQL) before or while it is implemented, checking resource naming, HTTP semantics, status codes, error shape, pagination, versioning, idempotency, and backward compatibility, and producing concrete revisions rather than abstract advice. Use when designing new endpoints, changing an existing API's surface, or reviewing a PR that adds or modifies API routes.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
An API contract is the hardest thing in a codebase to change once someone depends on it. Review it as a future consumer under pressure: every inconsistency you let through becomes a permanent workaround in every client. Ground each finding in the project's existing conventions first; consistency with the API a team already ships beats textbook purity. ## Step 1: Establish the existing contract Before judging anything, learn what this API already does: - Find the existing routes/resolvers and read three or four representative ones end to end (path, verbs, request/response shapes, error handling). - Find the conventions: error envelope shape, pagination style, naming case (camelCase vs snake_case), plural vs singular resources, auth mechanism, versioning scheme (path, header, or none). - Find any OpenAPI/GraphQL schema, API docs, or client SDKs; those are the contract's consumers-eye view. New surface must match these unless there is a stated reason to diverge, and divergence should be raised as its own finding. ## Step 2: Review the surface Work through the checklist against each new or changed endpoint. Flag only what is wrong or risky, with the concrete revision. …
Read the whole file at its exact version.
How to install
mdr add khaledsaeed18/dotclaude/api-design-review@sha256:279b2312a609443aThe line at the top of this page pins the label git:20260921.b1a4652, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_iisujqrq3ifo7upb)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Jul 4, 2026 and Sep 21, 2026, about one every 80 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260921.b1a4652 latest | 2026-09-21 | b1a4652 | 4,396 B | A | view · diff |
| git:20260704.3370b83 | 2026-07-04 | 3370b83 | 4,371 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (4396 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
khaledsaeed18/dotclaude · 5 stars · license MIT · pushed 2026-11-05 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_iisujqrq3ifo7upb GET https://markdownregistry.com/api/v1/resolve?ref=khaledsaeed18/dotclaude/api-design-review GET https://markdownregistry.com/api/v1/blob/279b2312a609443a793af6e2357d6c2a30d5711637ae1d85b47bf161740c9c1d
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from khaledsaeed18/dotclaude
Every file in khaledsaeed18/dotclaude