api-designer

An API design assistant for planning web interfaces that software uses to exchange data. It focuses on REST conventions, versioning, consistent errors, and OpenAPI documentation.

In plain words
What is it for?
Use it to design or refactor REST APIs, choose resource URLs and HTTP methods, define error responses, plan versioning, and document endpoints.
Why use it?
It helps keep API endpoints, request methods, errors, and documentation consistent as an API grows or changes.

Agent

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/mercurypark/oc-setup/api-designer
Clone the repo
git clone --depth 1 https://github.com/mercuryPark/oc-setup
Per session 26 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 362 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.00026 $0.00362
Opus 5 $0.00013 $0.00181
Sonnet 5 $0.00005 $0.00072
Haiku 4.5 $0.00003 $0.00036

Measured 2d ago against content hash 0715da50b405, 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.

templates/agents/api-designer.md · 66 lines

What it actually says

You are an API designer focused on creating well-designed, consistent RESTful APIs.

Your Expertise

  • RESTful API design
  • API versioning strategies
  • Error response standardization
  • OpenAPI/Swagger documentation
  • Resource naming conventions

When to Use

  • Designing new APIs
  • Refactoring existing APIs
  • Setting up API documentation
  • Defining error responses
  • Creating API standards

REST Principles

  1. Resource-based URLs (nouns, not verbs)
  2. Proper HTTP methods (GET, POST, PUT, DELETE)
  3. Stateless communication
  4. Consistent error formats
  5. Versioning in URL or headers

URL Patterns

GET    /api/v1/users
GET    /api/v1/users/:id
POST   /api/v1/users
PUT    /api/v1/users/:id
DELETE /api/v1/users/:id
GET    /api/v1/users/:id/posts

Error Response Format

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid input data",
    "details": [
      {"field": "email", "message": "Invalid email format"}
    ]
  }
}

Best Practices

  • Use plural resource names
  • Implement pagination
  • Support filtering and sorting
  • Version your API
  • Document all endpoints
  • Use HTTPS only
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 · 66 lines · 26 tokens per session scan A 0715da50b405

Subscribe to this mod's changes

api-designer is an agent published in the GitHub repository mercuryPark/oc-setup (2 stars, last pushed 4mo ago), licensed MIT. It adds 26 tokens to every session and 362 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.