rest-api-guidelines

rest-api-guidelines is a skill for Claude Code, Codex from tommymorgan/claude-plugins. It costs 40 tokens per session (3,319 once invoked), scanned A, original, MIT.

A set of rules for designing REST APIs, which are web interfaces that let programs exchange data over HTTP. It covers URLs, HTTP methods, errors, pagination, and versioning.

In plain words
What is it for?
Use it while planning or reviewing endpoints, resource names, create and update operations, error responses, page-by-page results, and API versions.
Why use it?
It helps keep an API consistent and predictable for the developers and programs that use it.

Skill for Claude CodeCodex

Part of the tommymorgan plugin — 10 skills, 14 commands, 13 agents, 4 hooks shipped together

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/tommymorgan/claude-plugins/rest-api-guidelines
Any agent
npx skills add tommymorgan/claude-plugins --skill rest-api-guidelines
Clone the repo
git clone --depth 1 https://github.com/tommymorgan/claude-plugins

Made for: Claude Code, Codex.

Or install tommymorgan, the plugin that ships this one along with the rest of its 10 skills, 14 commands, 13 agents, 4 hooks.

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 rest-api-guidelines

README.md
[![agentmods](https://agentmods.dev/badge/skills/tommymorgan/claude-plugins/rest-api-guidelines.svg)](https://agentmods.dev/skills/tommymorgan/claude-plugins/rest-api-guidelines)
Your own site
<a href="https://agentmods.dev/skills/tommymorgan/claude-plugins/rest-api-guidelines"><img src="https://agentmods.dev/badge/skills/tommymorgan/claude-plugins/rest-api-guidelines.svg" alt="Measured on agentmods" height="20"></a>
Per session 40 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,319 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.03319
Opus 5 $0.00020 $0.01659
Sonnet 5 $0.00008 $0.00664
Haiku 4.5 $0.00004 $0.00332

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

Security

Grade A, and why

rest-api-guidelines 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 4d 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.

tommymorgan/planning/skills/rest-api-guidelines/SKILL.md · 450 lines

How it starts

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

REST API Design Guidelines

Opinionated guidance for designing consistent, developer-friendly REST APIs. Apply these guidelines when designing new APIs or reviewing existing API designs.

URL Structure

Pattern: /{serviceRoot}/{collection}/{id}

URLs should be human-readable and hierarchical:

  • https://api.example.com/v1/people/[email protected]/inbox
  • https://api.example.com/v1/orders/12345/items

Rules:

  • Collection names: unabbreviated, pluralized nouns (/users, /orders, /messages)
  • Use path segments for hierarchy, not query parameters
  • Keep URLs short and predictable
  • Resources that can move or rename should expose stable identifier URLs

URL length: Design for under 2,083 characters to accommodate all clients.

HTTP Methods

Method Purpose Idempotent Key Rules
GET Retrieve resource Yes Safe, cacheable, no side effects
POST Create resource or submit command No Return 201 Created with Location header
PUT Replace entire resource Yes Full replacement — unspecified properties are removed
PATCH Partial update No Preferred over PUT for updates; supports UPSERT
DELETE Remove resource Yes Return 204 No Content
HEAD Metadata only (no body) Yes Same as GET without response body
OPTIONS Discover capabilities Yes Return Allow header listing supported methods

PATCH for UPSERT:

  • Without precondition headers: service determines create vs. update
  • With If-Match: update only (409 if missing)
  • With If-None-Match: *: create only (409 if exists)

Status Codes

Success

Code Meaning Use When
200 OK Standard success with response body
201 Created Resource created; include Location header
202 Accepted Long-running operation initiated
204 No Content Success with no response body (DELETE, some updates)

Read the full file on GitHub · 450 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. 4d ago First seen · 450 lines · 40 tokens per session scan A f8daf19e4c9c

Subscribe to this mod's changes

rest-api-guidelines is a skill published in the GitHub repository tommymorgan/claude-plugins (4 stars, last pushed 1mo ago), licensed MIT. It adds 40 tokens to every session and 3,319 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-31.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens