api-design

api-design is a command for coding agents from Ashfaqbs/software-dev-ai-claude-toolkit. It costs 7 tokens per session (315 once invoked), scanned A, original, MIT.

A planning command for designing REST APIs, which are web interfaces that let software read and change data over HTTP.

In plain words
What is it for?
Use it to plan API endpoints, request and response fields, authentication, database entities, pagination, filtering, sorting, and error handling.
Why use it?
It turns a feature idea into a clear list of URLs, data formats, permissions, and error responses before coding begins.

Command

Install

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.

agentmods
npx agentmods add commands/ashfaqbs/software-dev-ai-claude-toolkit/api-design
Clone the repo
git clone --depth 1 https://github.com/Ashfaqbs/software-dev-ai-claude-toolkit

Wrote 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.

agentmods badge for api-design

README.md
[![agentmods](https://agentmods.dev/badge/commands/ashfaqbs/software-dev-ai-claude-toolkit/api-design.svg)](https://agentmods.dev/commands/ashfaqbs/software-dev-ai-claude-toolkit/api-design)
Your own site
<a href="https://agentmods.dev/commands/ashfaqbs/software-dev-ai-claude-toolkit/api-design"><img src="https://agentmods.dev/badge/commands/ashfaqbs/software-dev-ai-claude-toolkit/api-design.svg" alt="Measured on agentmods" height="20"></a>
Per session 7 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 315 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

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.

ModelPer sessionOnce invoked
Fable 5 $0.00007 $0.00315
Opus 5 $0.00003 $0.00158
Sonnet 5 $0.00001 $0.00063
Haiku 4.5 $0.00001 $0.00032

Measured 4d ago against content hash ca41ea8497aa, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

api-design 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 4d 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.

commands/api-design.md · 40 lines

What it actually says

API Design

Design REST API endpoints for: $ARGUMENTS

Deliverables

  1. Endpoint list — method, path, description, auth required (yes/no)
  2. Request/Response schemas — with field names, types, required/optional, validation rules
  3. Error responses — standard error format with HTTP status codes
  4. Data model — what entities/collections/tables are needed

Format

For each endpoint, provide:

[METHOD] /api/v1/resource
Auth: required / public
Request body: { ... }
Response 200: { ... }
Response 400: { error: "...", details: [...] }

Guidelines

  • RESTful naming: plural nouns for collections (/users, /orders), no verbs in paths.
  • Use proper HTTP methods: GET (read), POST (create), PUT (full update), PATCH (partial update), DELETE.
  • Use proper status codes: 200, 201, 204, 400, 401, 403, 404, 409, 422, 500.
  • Pagination for list endpoints: ?page=1&size=20 or cursor-based.
  • Filter and sort support where applicable.
  • Consider rate limiting requirements.

Rules

  • DO NOT write code yet. This is design only.
  • WAIT for approval before implementation.
  • If the feature touches existing endpoints, read them first and stay consistent.
Changes

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.

  1. 4d ago First seen · 40 lines · 7 tokens per session scan A ca41ea8497aa

Subscribe to this mod's changes

api-design is a command published in the GitHub repository Ashfaqbs/software-dev-ai-claude-toolkit (24 stars, last pushed 6mo ago), licensed MIT. It adds 7 tokens to every session and 315 once invoked, about $0.0000 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-30.