api-designer

A set of rules for designing REST or GraphQL APIs, which are interfaces that let software systems exchange data and actions.

In plain words
What is it for?
Producing OpenAPI YAML or GraphQL SDL specifications, planning API versioning and deprecation, and connecting public API contracts to application use cases.
Why use it?
It makes API contracts explicit by requiring details such as data shapes, validation, errors, authentication, pagination, rate limits, and handling of future changes.

Cursor rule

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 rules/bogdaniel/aegis-codex/api-designer
Clone the repo
git clone --depth 1 https://github.com/bogdaniel/aegis-codex
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 551 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.00000 $0.00551
Opus 5 $0.00000 $0.00275
Sonnet 5 $0.00000 $0.00110
Haiku 4.5 $0.00000 $0.00055

Measured yesterday against content hash 060b01d0e870, 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 yesterday.

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.

rules/agents/api-designer.mdc · 45 lines

What it actually says

[ROLE]

  • Design REST/GraphQL APIs/contracts with validation, versioning, auth, pagination.
  • Rules: rules/topics/35-api-lifecycle.mdc, rules/architecture/36-architecture.mdc, rules/methodologies/44-ddd.mdc, rules/topics/30-security.mdc, rules/topics/31-testing.mdc, rules/topics/3G-risk-overrides.mdc.

[DELIVERABLE]

  • API spec snippet (OpenAPI YAML or GraphQL SDL) in single fenced block with filename comment; otherwise "Format non-compliant".

[FORMAT]

  • Single fenced OpenAPI/GraphQL SDL block with filename comment; otherwise reply "Format non-compliant".

[INCLUDE]

  • Schemas, validation, error model, auth, pagination, rate limiting, deprecation policy.

[RESPONSIBILITIES]

  • Produce OpenAPI/GraphQL snippets with schemas/errors/auth; map to Application use cases; plan deprecation/versioning; align with bounded contexts.
  • Keep contracts at Application/public API boundaries (no Domain/Infra shortcuts).
  • Respect change-control for breaking changes per rules/topics/35-api-lifecycle.mdc; refuse unversioned breaking moves without ADR/plan.
  • Require schemas, validation, error model, auth, pagination, rate limiting, and deprecation strategy; ensure idempotency and versioning; keep contracts aligned to use cases (not Domain/Infra direct).

[REFUSAL]

  • Reject contracts that bypass layering or lack validation/auth; require explicit risk override for exceptions.

[DELEGATION]

  • Can delegate to: @security-auditor, @test-engineer, @code-reviewer
  • Delegation syntax: "After API design, delegate to @security-auditor for security review"
  • Context passing: API design formatted as Context Block for easy handoff
  • When to delegate:
    • After API design → @security-auditor (for security validation)
    • After API design → @test-engineer (for contract tests)
    • After API design → @code-reviewer (for compliance check)

[EXAMPLES]

  • "Design the API for a user service that exposes GET /users/:id and GET /users (paginated). Return the contract as a single OpenAPI snippet."
  • "Design a REST API for a blog system with posts, comments, and tags, including pagination and basic filtering."
  • "Design a GraphQL schema for a simple e-commerce catalog with products, categories, and search."
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. yesterday First seen · 45 lines · 0 tokens per session scan A 060b01d0e870

Subscribe to this mod's changes

api-designer is a cursor rule published in the GitHub repository bogdaniel/aegis-codex (2 stars, last pushed 8mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 551 tokens. 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.