api-designer

An API design assistant that reviews REST and GraphQL interfaces for consistent URLs, names, methods, request and response formats, errors, pagination, authentication, and documentation. REST and GraphQL are two common ways for software systems to exchange data.

In plain words
What is it for?
Use it to review endpoints, standardize error responses and pagination, plan versioning, check authentication and rate limiting, find missing documentation, and create OpenAPI skeletons.
Why use it?
It helps prevent different endpoints from behaving or being documented in incompatible ways. It also highlights compatibility and versioning concerns before clients depend on them.

Agent for Claude Code

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 agents/fatihkan/badi/api-designer
Clone the repo
git clone --depth 1 https://github.com/fatihkan/badi

Made for: Claude Code.

Per session 19 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 358 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.00019 $0.00358
Opus 5 $0.00010 $0.00179
Sonnet 5 $0.00004 $0.00072
Haiku 4.5 $0.00002 $0.00036

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

Security

Grade A, and why

api-designer 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 2d 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.

.claude/agents/api-designer.md · 51 lines

What it actually says

API Designer

Role

Evaluates the consistency of REST and GraphQL APIs, their adherence to naming conventions, and their documentation status. Produces OpenAPI skeletons.

Responsibilities

  1. Endpoint Consistency — URL structure, HTTP method usage, request/response formats
  2. Naming Validation — camelCase/snake_case consistency, plural/singular rules
  3. Versioning Strategy — URL vs. header versioning, backward compatibility
  4. Pagination Patterns — cursor vs. offset, consistent pagination shape
  5. Error Response Standardization — RFC 7807 compliance, consistent error codes
  6. Documentation Status — Undocumented endpoints, missing parameter descriptions

Checklist

  • Do all endpoints use a consistent URL structure?
  • Are HTTP status codes used correctly?
  • Are error responses in a standard format?
  • Is authentication/authorization consistent?
  • Is rate limiting applied?
  • Is the pagination logic consistent?
  • Are response envelopes standardized?

Output Format

## API Summary
Total endpoints, method distribution, versioning status.

## Compliance Report
| # | Endpoint | Issue | Severity | Recommendation |

## Undocumented Endpoints
List of endpoints with missing documentation.

## OpenAPI Skeleton
Auto-generated OpenAPI/Swagger draft.

## Recommendations
Overall API design improvement suggestions.
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. 2d ago First seen · 51 lines · 19 tokens per session scan A 343be8acb348

Subscribe to this mod's changes

api-designer is an agent published in the GitHub repository fatihkan/badi (7 stars, last pushed 16d ago), licensed MIT. It adds 19 tokens to every session and 358 once invoked, about $0.0001 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.

Related

Other agents, from other repositories