Agent skill

API Design

by agulli in agulli/atlas-agents

Design or review REST and GraphQL API interfaces. An agent skill from agulli/atlas-agents.

MITAuto-check passedBackend & APIs

Install API Design

skills CLI
$ npx skills add agulli/atlas-agents --skill api-design -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install agulli/atlas-agents api-design --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/agulli/atlas-agents.git skills-src && mkdir -p .claude/skills && cp -r skills-src/ch09_agent_skills/skills/api-design .claude/skills/api-design && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
api-design
GitHub stars
578
Token cost
~539 tokens
SKILL.md length
257 words
Files
1
Skills in repo
12
Repo updated
First seen
Licence
MIT

At a glance

Design or review REST and GraphQL API interfaces. An agent skill from agulli/atlas-agents.

  • Works in 6 steps: Identify the domain objects. List every… → Design the resource hierarchy. Use… → Define schemas. Write request and… → …
  • Asked to design an API
  • SKILL.md covers Overview, Process, Rationalizations and Verification
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

API Design is an agent skill from agulli/atlas-agents. Design or review REST and GraphQL API interfaces. Use when asked to design an API, review endpoint structure, define request/response schemas, or improve API ergonomics.

Its SKILL.md is about 540 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Backend & APIs, covering API design and GraphQL. It works with GraphQL. The licence is MIT.

When your agent uses it

  • Asked to design an API
  • Review endpoint structure
  • Define request/response schemas
  • Improve API ergonomics

Example prompts

  • “/api-design”

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

  1. Identify the domain objects. List every noun the API needs to represent. Group them by relationship.
  2. Design the resource hierarchy. Use plural nouns for collections: /users, /users/{id}/orders. Never use verbs in URLs — the HTTP method IS…
  3. Define schemas. Write request and response schemas as JSON examples. Every field must have
  4. Error contract. Define a consistent error envelope
  5. Pagination. All list endpoints must support cursor-based pagination by default. Offset pagination is acceptable only if explicitly…
  6. Versioning. Use URL path versioning (/v1/) unless the project already uses header versioning.

What it can do on your machine

Read from SKILL.md and the folder at commit 2b21998. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are json).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

API Design loads about 539 tokens when it runs. Until then it costs about 45 tokens; SKILL.md has 257 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~45
When it runs · the whole SKILL.md, loaded when a task matches
~539

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from agulli/atlas-agents at commit 2b21998, republished under its MIT licence (© agulli). 257 words, ~539 tokens.

Download SKILL.mdSave it as .claude/skills/api-design/SKILL.md (or your agent's skills folder).
name
api-design
description
Design or review REST and GraphQL API interfaces. Use when asked to design an API, review endpoint structure, define request/response schemas, or improve API ergonomics.
license
MIT

Overview

You are designing APIs that other developers — and other agents — will consume. Clarity and predictability matter more than cleverness.

Process

  1. Identify the domain objects. List every noun the API needs to represent. Group them by relationship.
  2. Design the resource hierarchy. Use plural nouns for collections: /users, /users/{id}/orders. Never use verbs in URLs — the HTTP method IS the verb.
  3. Define schemas. Write request and response schemas as JSON examples. Every field must have:
    • A type
    • Whether it's required or optional
    • An example value
    • Validation constraints (min/max length, regex pattern, allowed values)
  4. Error contract. Define a consistent error envelope:
    json
    {"error": {"code": "VALIDATION_FAILED", "message": "...", "details": [...]}}
    Use HTTP status codes correctly: 400 for bad input, 401 for auth, 403 for forbidden, 404 for not found, 409 for conflicts, 422 for semantic errors.
  5. Pagination. All list endpoints must support cursor-based pagination by default. Offset pagination is acceptable only if explicitly requested.
  6. Versioning. Use URL path versioning (/v1/) unless the project already uses header versioning.

Rationalizations

ExcuseRebuttal
"We can add pagination later"No. Adding pagination to an existing endpoint is a breaking change. Design it in from day one.
"Let's use a generic /api/action endpoint with a type field"This is RPC masquerading as REST. Use proper resource URLs.
"We don't need error codes, the message is enough"Machines parse codes, humans read messages. You need both.

Verification

  • Every endpoint has a documented request schema, response schema, and at least one error response
  • All list endpoints support pagination
  • No verbs in URL paths
  • Error responses follow the standard envelope format

© agulli, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in ch09_agent_skills/skills/api-design of agulli/atlas-agents.

Open the folder on GitHubat commit 2b21998

Compare with similar skills

API Design next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

API Design compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
API Design this skillagulli/atlas-agents578—~539Automated safety check: PassMIT
API DesignerJeffallan/claude-skills12k2 repos~2kAutomated safety check: PassMIT
Nodejs Backend Patternsever-works/ever-works15817 repos~4kAutomated safety check: PassAGPL-3.0
API And Interface Designdzhalaevd/Donatello1359 repos~2.6kAutomated safety check: PassApache-2.0
API Design Principlesjh941213/my-cc-harness12619 repos~3.4kAutomated safety check: PassNone
Designing APIsCloudAI-X/claude-workflow-v21.4k2 repos~1.2kAutomated safety check: PassMIT

Similar skills

  • API Designer

    Jeffallan/claude-skills

    Designs REST and GraphQL APIs from resource modeling to an OpenAPI 3.1 contract, with versioning, pagination and RFC 7807 error handling.

    12k GitHub starsUsed in 2 repos~2k tokens
    Backend & APIsAuto-check passed
  • Nodejs Backend Patterns

    ever-works/ever-works

    Build production-ready Node.js backend services with Express/Fastify, implementing middleware patterns, error handling, authentication, database integration, and API design best practices.

    158 GitHub starsUsed in 17 repos~4k tokens
    Backend & APIsAuto-check passed
  • API And Interface Design

    dzhalaevd/Donatello

    Guides stable API and interface design. An agent skill from dzhalaevd/Donatello.

    135 GitHub starsUsed in 9 repos~2.6k tokens
    Backend & APIsAuto-check passed
  • API Design Principles

    jh941213/my-cc-harness

    REST 및 GraphQL API 설계 원칙 가이드. An agent skill from jh941213/my-cc-harness.

    126 GitHub starsUsed in 19 repos~3.4k tokens
    Backend & APIsAuto-check passed
  • Designing APIs

    CloudAI-X/claude-workflow-v2

    Designs REST and GraphQL APIs including endpoints, error handling, versioning, and documentation.

    1.4k GitHub starsUsed in 2 repos~1.2k tokens
    Backend & APIsAuto-check passed
  • GraphQL Architect

    Jeffallan/claude-skills

    Designs GraphQL schemas and Apollo Federation graphs, with DataLoader resolvers, subscriptions, query complexity limits and caching.

    12k GitHub starsUsed in 1 repo~1.3k tokens
    Backend & APIsAuto-check passed

More from agulli/atlas-agents

All 12 skills in this repo
  • Data Pipeline

    agulli/atlas-agents

    Design, build, or debug data processing pipelines. An agent skill from agulli/atlas-agents.

    578 GitHub stars~714 tokensUpdated 2 mo ago
    Auto-check passed
  • Database Migration

    agulli/atlas-agents

    Safely run database schema migrations. An agent skill from agulli/atlas-agents.

    578 GitHub stars~702 tokensUpdated 2 mo ago
    Auto-check passed
  • Deploy Checklist

    agulli/atlas-agents

    Execute a structured deployment to staging or production. An agent skill from agulli/atlas-agents.

    578 GitHub stars~756 tokensUpdated 2 mo ago
    Auto-check passed
  • Documentation Writer

    agulli/atlas-agents

    Write or update technical documentation for code, APIs, or systems.

    578 GitHub stars~639 tokensUpdated 2 mo ago
    Auto-check passed
  • Git Commit

    agulli/atlas-agents

    Create well-structured git commits with conventional commit messages.

    578 GitHub stars~463 tokensUpdated 2 mo ago
    Auto-check: notes
  • Performance Profiling

    agulli/atlas-agents

    Profile and optimize application performance. An agent skill from agulli/atlas-agents.

    578 GitHub stars~804 tokensUpdated 2 mo ago
    Auto-check passed

Works with

Categories

Questions about API Design

What does API Design do?

Design or review REST and GraphQL API interfaces. An agent skill from agulli/atlas-agents. API Design is an agent skill from agulli/atlas-agents. Design or review REST and GraphQL API interfaces.

When should I use API Design?

API Design fits situations like: asked to design an API; review endpoint structure; define request/response schemas; improve API ergonomics.

How do I install API Design in Claude Code?

Run `npx skills add agulli/atlas-agents --skill api-design -a claude-code`. Or copy the skill folder (ch09_agent_skills/skills/api-design in agulli/atlas-agents) into .claude/skills/api-design in your project. Claude Code loads it when a task matches its description.

How do I install API Design in Codex?

Run `npx skills add agulli/atlas-agents --skill api-design -a codex`. Or copy the skill folder (ch09_agent_skills/skills/api-design in agulli/atlas-agents) into .agents/skills/api-design in your project. Codex loads it when a task matches its description.

Can I use API Design in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add agulli/atlas-agents --skill api-design -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-design, .gemini/skills/api-design, .github/skills/api-design and .opencode/skills/api-design in your project.

What does API Design need to run?

SKILL.md names no scripts, command-line tools or credentials: API Design is instructions for the agent only.

Does API Design access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is API Design safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does API Design use?

API Design is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does API Design use?

About 539 tokens (SKILL.md is roughly 2.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to API Design?

Skills that share tags, products or a category with API Design: API Designer (Jeffallan/claude-skills, 12k stars), Nodejs Backend Patterns (ever-works/ever-works, 158 stars), API And Interface Design (dzhalaevd/Donatello, 135 stars) and API Design Principles (jh941213/my-cc-harness, 126 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains API Design?

agulli (a GitHub user) maintains it in agulli/atlas-agents, which has 578 GitHub stars. The repository holds 12 skills in this directory. The repository was last updated on July 17, 2026.

Source: agulli/atlas-agents on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.