api-design

An API design and review assistant for Authgear, a software platform for authentication. An API is the defined way that software exposes data or actions to other software.

In plain words
What is it for?
Use it to design or review Authgear HTTP and GraphQL APIs, configuration structures, and authentication-related interfaces.
Why use it?
It gives proposed or existing API designs a consistent review against the project's documented conventions.

Skill for Claude CodeCodex

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 skills/authgear/authgear-server/api-design
Any agent
npx skills add authgear/authgear-server --skill api-design
Clone the repo
git clone --depth 1 https://github.com/authgear/authgear-server

Made for: Claude Code, Codex.

Per session 40 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,472 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.00040 $0.02472
Opus 5 $0.00020 $0.01236
Sonnet 5 $0.00008 $0.00494
Haiku 4.5 $0.00004 $0.00247

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

Security

Grade A, and why

api-design 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/skills/api-design/SKILL.md · 234 lines

How it starts

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

You are an Authgear API design expert. Based on the user's input, determine the mode:

  • Review mode: User provides a specific design draft (e.g., "Review this config struct:", "Here is my proposed GraphQL mutation:"). Evaluate it against the checklist.
  • Ideation mode: User describes a feature or idea without a concrete draft (e.g., "Design an API for X", "How should we add Y?"). Develop a design first, then self-review it.

Step 1: Load context (parallel)

Read all of these files in parallel:

  1. docs/specs/glossary.md — canonical terms
  2. docs/specs/convention.md — naming and design conventions
  3. docs/specs/config.md — config YAML conventions
  4. docs/specs/api.md — HTTP API conventions
  5. docs/specs/api-admin.md — Admin GraphQL API conventions

Also read any feature-specific spec that is clearly relevant to the user's input (e.g., if the user mentions "authentication flow", read docs/specs/authentication-flow.md). Read these in the same parallel batch.


Step 2: Load relevant code (parallel)

Based on which API surface is involved, read existing code for pattern comparison. Determine the surface from the user's input, then read the relevant files in parallel:

  • Config (authgear.yaml): Read pkg/lib/config/config.go and one similar feature config file (e.g., pkg/lib/config/bot_protection.go or pkg/lib/config/fraud_protection.go)
  • Admin API (GraphQL): Read 2–3 representative files from pkg/admin/graphql/ — pick one node file and one mutation file that are closest to the proposed feature
  • HTTP API: Read 1–2 handler files from pkg/auth/handler/api/ that are closest to the proposed feature
  • Authflow API: Read docs/specs/authentication-flow-api-reference.md
  • Account Management API: Read docs/specs/account-management-api.md

If multiple surfaces are involved, load code for all of them.


Step 3: Analyze

Review mode

Evaluate the design against every item in the checklist below. For each item, assign a status:

Read the full file on GitHub · 234 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 · 234 lines · 40 tokens per session scan A 58975b084d9d

Subscribe to this mod's changes

api-design is a skill published in the GitHub repository authgear/authgear-server (2,017 stars, last pushed today), licensed Apache-2.0. It adds 40 tokens to every session and 2,472 once invoked, about $0.0002 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 skills, from other repositories