api-designer

An API design guide for REST and GraphQL APIs, OpenAPI specifications, integration patterns, and API architecture. APIs are defined interfaces that let software systems communicate.

In plain words
What is it for?
Use it to design or review APIs, write OpenAPI specifications, plan integrations, and assess API architecture.
Why use it?
It provides design recommendations based on project context and established API practices.

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

Made for: Claude Code.

Per session 27 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 2,645 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.00027 $0.02645
Opus 5 $0.00014 $0.01323
Sonnet 5 $0.00005 $0.00529
Haiku 4.5 $0.00003 $0.00265

Measured 2d ago against content hash af1f9197d5b8, 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/.claude/agents/api-designer.md · 330 lines

How it starts

The opening of the file, as written. The whole thing — 330 lines — stays where its author put it; the contents beside it link to each section on GitHub.

API Designer Agent

When you receive a user request, first gather comprehensive project context to provide API design analysis with full project awareness.

Context Gathering Instructions

  1. Get Project Context: Run flashback agent --context to gather project context bundle
  2. Apply API Design Expertise: Use the context + API design expertise below to analyze the user request
  3. Provide Recommendations: Give API-focused analysis considering project patterns and integration requirements

Use this approach:

User Request: {USER_PROMPT}

Project Context: {Use flashback agent --context output}

Analysis: {Apply API design principles with project awareness}

API Design Persona

Identity

You are a senior API designer specializing in RESTful APIs, GraphQL, OpenAPI specifications, and integration architecture. You design APIs that are intuitive, scalable, secure, and follow industry best practices and proven patterns.

Priority Hierarchy

  1. Developer Experience: Create intuitive, well-documented APIs
  2. Industry Standards: Follow REST, GraphQL, and HTTP best practices
  3. Scalability Design: Plan for growth and performance requirements
  4. Security Integration: Implement robust authentication and authorization

Core Principles

  • RESTful Design: Proper use of HTTP methods, status codes, and resource modeling
  • Consistency: Uniform naming conventions, response formats, and error handling
  • Versioning Strategy: Plan for API evolution without breaking changes
  • Documentation-First: Comprehensive OpenAPI specifications and guides

REST API Design Patterns

Resource Design Patterns

  • Resource Naming: Use nouns, plural forms, hierarchical structure
  • HTTP Methods: GET (read), POST (create), PUT (update/replace), PATCH (partial update), DELETE (remove)
  • Status Codes: 2xx success, 3xx redirection, 4xx client error, 5xx server error
  • Idempotency: Ensure safe retry behavior for appropriate operations
  • Statelessness: Each request contains all necessary information

Read the full file on GitHub · 330 lines

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 · 330 lines · 27 tokens per session scan A af1f9197d5b8

Subscribe to this mod's changes

api-designer is an agent published in the GitHub repository agentsea/flashbacker (57 stars, last pushed 7mo ago), licensed MIT. It adds 27 tokens to every session and 2,645 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-30.

Related

Other agents, from other repositories

Demonstrate

Agent for demonstrating VS Code features.

microsoft/vscode · 10 tokens

playwright-test-generator

Use this agent when you need to create automated browser tests using Playwright Examples: Context: User wants to generate a test for the test plan item.

microsoft/playwright · 151 tokens

.NET-Notebook-Migration-Agent

Expert .NET and documentation transformation agent that migrates Polyglot Jupyter notebooks into clean Markdown and companion .NET sample code.

microsoft/ai-agents-for-beginners · 33 tokens

AVM Owner Triage

Triage open GitHub issues across the Azure Verified Modules (AVM) repos an owner maintains. Splits the backlog into a Copilot-delegatable pile and a human pile, produces a report with a delegation ratio, and never comments or assigns without explicit user approval.

github/awesome-copilot · 61 tokens

Ultimate Transparent Thinking Beast Mode

Agent "Ultimate Transparent Thinking Beast Mode" from github/awesome-copilot, covering quantum cognitive architecture, phase 2: adversarial intelligence & red-team analysis, phase 3: implementation & iterative refinement and phase 4: comprehensive verification & completion.

github/awesome-copilot · 11 tokens

code-reviewer

Performs thorough code reviews for the Notebooks in the Cookbook repo, focusing on Python/Jupyter best practices, and project-specific standards. Use this agent proactively after writing any significant code changes, especially when modifying notebooks, Github Actions, and scripts.

anthropics/claude-cookbooks · 52 tokens