api-designer

api-designer is an agent for Claude Code from dshakes/compass. It costs 62 tokens per session (430 once invoked), scanned A, original, MIT.

An assistant for designing APIs: the rules that let software systems communicate, including REST endpoints and gRPC messages. It helps define what callers send and receive, and how the interface changes over time.

In plain words
What is it for?
Use it to draft or review OpenAPI routes, protobuf files, and service interfaces. It also helps assess backward compatibility and run available contract checks.
Why use it?
API changes can break existing clients and are costly to undo. It helps check compatibility, validation, versioning, errors, pagination, and other parts of the contract before implementation.

Agent for Claude Code

Written for Claude Code: a Claude Code subagent (agents/*.md). Also seen: model in frontmatter.

Good fit Use it to draft or review OpenAPI routes, protobuf files, and service interfaces. It also helps assess backward compatibility and run available contract checks.

Compare 6 agents from other repositories ↓
Install with agentmods
npx agentmods add agents/dshakes/compass/api-designer
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.

Clone the repo
git clone --depth 1 https://github.com/dshakes/compass

Made for: Claude Code.

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-designer

README.md
[![agentmods](https://agentmods.dev/badge/agents/dshakes/compass/api-designer/github.svg)](https://agentmods.dev/agents/dshakes/compass/api-designer)
Your own site
<a href="https://agentmods.dev/agents/dshakes/compass/api-designer"><img src="https://agentmods.dev/badge/agents/dshakes/compass/api-designer/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for api-designer

Your own site · 80×15
<a href="https://agentmods.dev/agents/dshakes/compass/api-designer"><img src="https://agentmods.dev/badge/agents/dshakes/compass/api-designer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 62 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 430 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00062 $0.00430
Opus 5.5 $0.00025 $0.00172
Sonnet 5.5 $0.00012 $0.00086
Haiku 4.5 $0.00006 $0.00043

Measured 1mo ago against content hash b745268e8199, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 1mo 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 · 34 lines

What it actually says

You are an API designer. The contract is a promise to callers you can't easily take back, so you optimize for the caller and for the version after this one.

Standards

  • Proto/schema is the source of truth for cross-service types; keep it buf clean and never hand-edit generated code.
  • Backward compatibility is default. New fields optional with sane defaults; never renumber a proto field, repurpose a name, or tighten a type in place. Breaking changes get a new version, not a silent mutation.
  • Devex: names and shapes read the same across the surface; errors are typed and actionable (code + message + retryable), not a bare 500; pagination, idempotency, and null-vs-absent handled explicitly.
  • Versioning strategy stated — URL/header/package — and how a client migrates.
  • Validation belongs at the boundary; document what's required vs optional and what a malformed request gets back.

Workflow

Read the existing contracts and how callers use them first. Draft or change the .proto/OpenAPI/route definitions. Run the repo's contract checks (buf lint, buf breaking, schema/OpenAPI lint) and regenerate types where they exist. Report the contract, the compatibility impact (safe / needs new version), and the client-migration note. Stay in scope.

Paste the actual check output. If a check couldn't run (tool or permission missing), report it as UNVERIFIED and say why — never claim a change is backward-compatible unless a breaking-change check confirmed it.

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. 1mo ago First seen · 34 lines · 62 tokens per session scan A b745268e8199

Subscribe to this mod's changes

api-designer is an agent published in the GitHub repository dshakes/compass (19 stars, last pushed 3d ago), licensed MIT. It adds 62 tokens to every session and 430 once invoked, about $0.0002 per session on Opus 5.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

fastapi-reviewer

Reviews FastAPI applications for async correctness, dependency injection, Pydantic schemas, security, OpenAPI quality, testing, and production readiness.

affaan-m/ECC · 33 tokens

rust-framework-architect

Use this agent when working on the AgentSight collector framework architecture, implementing new runners or analyzers, designing event pipelines, or making changes to the streaming analysis system. Examples: Context: User is implementing a new analyzer for the streaming framework. user: 'I need to create a new…

eunomia-bpf/agentsight · 0 tokens

api-spec-writer

Produces api-requirements.md from an approved plan. Extracts tasks requiring backend APIs and generates comprehensive endpoint specifications with traceability.

closedloop-ai/claude-plugins · 31 tokens

java-pro

Master modern Java with streams, concurrency, and JVM optimization. Handles Spring Boot, reactive programming, and enterprise patterns. Use PROACTIVELY for Java performance tuning, concurrent programming, or complex enterprise solutions.

echoVic/blade-code · 44 tokens

api-documenter

Create OpenAPI/Swagger specs, generate SDKs, and write developer documentation. Handles versioning, examples, and interactive docs. Use PROACTIVELY for API documentation or client library generation.

echoVic/blade-code · 43 tokens

scg-mapper

Maps a set of connectors into the Source Capability Graph (SCG) via a deterministic state machine — introspect, parse structure, link entities, finalize. Indexes reachability only, never the data behind it.

bearlike/Assistant · 48 tokens