api-design

api-design is a skill for Claude Code from andr-ca/agentharness. It costs 39 tokens per session (1,524 once invoked), scanned A, original, MIT.

A guide for designing REST and GraphQL APIs, which are ways for software systems to exchange data. It covers naming, status codes, versions, errors, pagination, and authentication.

In plain words
What is it for?
Use it when creating or reviewing endpoints, data fields, error responses, pagination, authentication, or API versioning.
Why use it?
It helps make an API predictable for its users and easier to change without breaking existing programs.

Skill for Claude Code

Written for Claude Code: installed under .claude/.

Good fit Use it when creating or reviewing endpoints, data fields, error responses, pagination, authentication, or API versioning.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/andr-ca/agentharness/api-design
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.

Any agent
npx skills add andr-ca/agentharness --skill api-design
Clone the repo
git clone --depth 1 https://github.com/andr-ca/agentharness

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

README.md
[![agentmods](https://agentmods.dev/badge/skills/andr-ca/agentharness/api-design/github.svg)](https://agentmods.dev/skills/andr-ca/agentharness/api-design)
Your own site
<a href="https://agentmods.dev/skills/andr-ca/agentharness/api-design"><img src="https://agentmods.dev/badge/skills/andr-ca/agentharness/api-design/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-design

Your own site · 80×15
<a href="https://agentmods.dev/skills/andr-ca/agentharness/api-design"><img src="https://agentmods.dev/badge/skills/andr-ca/agentharness/api-design.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 39 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,524 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.00039 $0.01524
Opus 5.5 $0.00016 $0.00610
Sonnet 5.5 $0.00008 $0.00305
Haiku 4.5 $0.00004 $0.00152

Measured 1mo ago against content hash 94eecaffa9de, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 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/skills/api-design/SKILL.md · 187 lines

How it starts

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

API Design

Design choices for HTTP APIs (REST-style and GraphQL). The goal is an API that is consistent, predictable, and easy to evolve without breaking callers.

Reference: Google API Design Guide, JSON:API, RFC 9457 (Problem Details for HTTP APIs).


Resource naming (REST)

Use nouns, not verbs. Collections are plural.

GET    /users              → list users
POST   /users              → create a user
GET    /users/{id}         → get one user
PATCH  /users/{id}         → partial update
PUT    /users/{id}         → full replace
DELETE /users/{id}         → delete

GET    /users/{id}/posts   → posts belonging to a user
POST   /users/{id}/posts   → create a post for a user

Actions that don't map cleanly to CRUD go on a sub-resource with a verb:

POST   /users/{id}/activate
POST   /payments/{id}/refund

Naming rules:

  • kebab-case for multi-word path segments (/user-profiles, not /userProfiles or /user_profiles)
  • camelCase for JSON field names (consistent with most JS/TS clients)
  • IDs in path, filters/pagination in query string

HTTP status codes — use them correctly

Code Meaning Use for
200 OK Successful GET, PATCH, PUT
201 Created Successful POST that creates a resource
204 No Content Successful DELETE or action with no response body
400 Bad Request Client sent invalid data (validation failure)
401 Unauthorized Not authenticated (no or invalid token)
403 Forbidden Authenticated but not permitted for this resource
404 Not Found Resource doesn't exist (or is hidden for auth reasons)
409 Conflict Duplicate creation, optimistic lock failure
422 Unprocessable Entity Syntactically valid but semantically invalid input
429 Too Many Requests Rate limit exceeded
500 Internal Server Error Unexpected server failure (never expose details)

Read the full file on GitHub · 187 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. 1mo ago First seen · 187 lines · 39 tokens per session scan A 94eecaffa9de

Subscribe to this mod's changes

api-design is a skill published in the GitHub repository andr-ca/agentharness (1 stars, last pushed 2d ago), licensed MIT. It adds 39 tokens to every session and 1,524 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-31.

Related

Other skills, from other repositories

deepstream-sop

Use this skill when building, deploying, evaluating, debugging, or measuring latency for the DeepStream SOP Inference Microservice — a GPU-accelerated FastAPI service that detects whether operators perform assembly-line steps in order via event boundary detection (GEBD) plus VLM classification. Trigger even if the…

NVIDIA/skills · 219 tokens

nemo-fabric-integrate

Use this skill when integrating NVIDIA NeMo Fabric into a consumer application, service, evaluation harness, or platform through the typed Python SDK — translating the consumer's own application, job, or deployment config into an in-memory FabricConfig, choosing the single-invocation convenience API or an explicitly…

NVIDIA/skills · 83 tokens

ambient-healthcare-agent-with-nemotron-voice-agent

Customize NVIDIA Nemotron Voice Agent's Generic Pipecat example for healthcare appointment, five-field patient intake, or custom tool-calling workflows without a separate backend.

NVIDIA/skills · 44 tokens

nemo-fabric-build-adapter

Build, migrate, review, and maintain third-party NVIDIA NeMo Fabric adapters against the public adapter contract. Use when creating adapter or target descriptors, mapping AgentConfig into an agent harness or custom-agent runtime, implementing start/invoke/stop, declaring schemas and capabilities, packaging discovery…

NVIDIA/skills · 87 tokens

earth2studio-create-datasource

Create and validate Earth2Studio data source wrappers (DataSource, ForecastSource, DataFrameSource, ForecastFrameSource) from remote stores. Do NOT use for fetching data with existing sources, model inference, or installation tasks.

NVIDIA/skills · 53 tokens

dynamo-recipe-runner

Select, validate, patch, and deploy existing NVIDIA Dynamo Kubernetes recipes. Use for model/backend/GPU/deployment-mode recipe bring-up; use router-starter for router-only mode work and troubleshoot for broken deployments.

NVIDIA/skills · 49 tokens