Getting it into your agent
One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.
npx agentmods add skills/vimalk0703/shipworthy/api-design-standardsnpx skills add Vimalk0703/shipworthy --skill api-design-standardsgit clone --depth 1 https://github.com/Vimalk0703/shipworthyWrote this? Show the measurements
A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.
[](https://agentmods.dev/skills/vimalk0703/shipworthy/api-design-standards)<a href="https://agentmods.dev/skills/vimalk0703/shipworthy/api-design-standards"><img src="https://agentmods.dev/badge/skills/vimalk0703/shipworthy/api-design-standards.svg" alt="Measured on agentmods" height="20"></a>What it costs to keep this loaded
Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.00032 | $0.00431 |
| Opus 5 | $0.00016 | $0.00216 |
| Sonnet 5 | $0.00006 | $0.00086 |
| Haiku 4.5 | $0.00003 | $0.00043 |
Grade A, and why
api-design-standards scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 5d ago.
A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.
Nothing flagged
None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.
What it actually says
API Design Standards
URL Conventions
- Resources are plural nouns:
/users,/orders,/products - Nested for relationships:
/users/:id/orders - Lowercase, hyphen-separated:
/order-itemsnot/orderItems - No trailing slashes
HTTP Methods
| Method | Purpose | Idempotent | Body |
|---|---|---|---|
| GET | Read | Yes | No |
| POST | Create | No | Yes |
| PUT | Full replace | Yes | Yes |
| PATCH | Partial update | Yes | Yes |
| DELETE | Remove | Yes | No |
Status Codes
200OK,201Created,204No Content400Bad Request,401Unauthorized,403Forbidden,404Not Found,409Conflict,422Unprocessable,429Rate Limited500Internal Error,503Unavailable
Error Response Format (consistent across ALL endpoints)
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Email address is invalid",
"details": [{ "field": "email", "message": "Must be a valid email" }]
}
}
Pagination
GET /users?page=1&limit=20
Response: { "data": [...], "pagination": { "total": 150, "page": 1, "limit": 20, "hasMore": true } }
Requirements
- Every endpoint MUST have request and response types defined
- Choose one versioning strategy per project (
/api/v1/or header-based) - Keep API documentation in sync with code
What this file has done since we first saw it
Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.
- 5d ago First seen · 51 lines · 32 tokens per session scan A 6b736cd0e2df
api-design-standards is a skill published in the GitHub repository Vimalk0703/shipworthy (7 stars, last pushed 4mo ago), licensed MIT. It adds 32 tokens to every session and 431 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.
Other skills, from other repositories
hedgehog-core-design
Use on full-stack-app and landing-page alike only when neither shipped core fits a project that is still building something real — picks the stack and designs the layer sequence for it, and writes .hedgehog/core.yaml. Invoked by the planner agent as Phase 0's third outcome, after the vendored BMAD shelf has run; don't…
hedgehog-planning-intake
Use on any core for first-run planning intake — Phase 0 runs the vendored BMAD-METHOD planning shelf, shared by every core, and Phase 1 (mining 04-prd.md into intent records plus the Add-ons/sync-and-remote-entities decision) is full-stack-app's and pwa-app's shared procedure — identical mechanics, a different…
inbound-triage
Maintainer-only. Use when triaging inbound GitHub issues and pull requests on skyf0xx/hedgehog — "triage the issues", "check the PRs", "review inbound", "what's in the queue". Reads each item read-only, judges it for security and for whether it is real, then fixes and closes or comments and closes. Not part of the…
bmad-product-brief
Create, update, or validate a product brief. Use when the user wants help producing, editing, or validating a brief.
bmad-deep-recon
Decision-grade research, three ways: draft a deep-research prompt for the user to run in their own tool (ChatGPT, Gemini, Grok, Perplexity, …), process a finished research report — file it, distill a succinct cited summary with metadata that downstream skills consume without reprocessing — or run the research here…
bmad-revendor
Maintainer-only. Use when re-vendoring vendor-skills/BMAD/ against a newer BMAD-METHOD commit — "update BMAD", "re-vendor BMAD", "bump the BMAD pin". Not part of the Hedgehog discipline a consuming project copies; this only applies to the Hedgehog repo itself.