Agent skill

API Conventions

by willdady in willdady/platypus

Response-body conventions for the Platypus backend API — the error key for failures, the message key for 2xx status messages, and when to throw a typed error instead of returning a response.

MITAuto-check passedProductivity & Automation

Install API Conventions

skills CLI
$ npx skills add willdady/platypus --skill api-conventions -a claude-code

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

GitHub CLI
$ gh skill install willdady/platypus api-conventions --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/willdady/platypus.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/api-conventions .claude/skills/api-conventions && 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-conventions
GitHub stars
116
Token cost
~655 tokens
SKILL.md length
285 words
Files
1
Skills in repo
7
Repo updated
First seen
Licence
MIT

At a glance

Response-body conventions for the Platypus backend API — the error key for failures, the message key for 2xx status messages, and when to throw a typed error instead of returning a response.

  • Changing a backend route
  • SKILL.md covers The two keys, The error seam and Test assertions
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

API Conventions is an agent skill from willdady/platypus. Response-body conventions for the Platypus backend API — the error key for failures, the message key for 2xx status messages, and when to throw a typed error instead of returning a response. Use when adding or changing a backend route or its tests.

Its SKILL.md is about 660 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 Productivity & Automation. The repository describes itself as: Self-hosted AI Agents for your whole team — on your infrastructure, your models, around the clock. The licence is MIT.

When your agent uses it

  • Changing a backend route

Example prompts

  • “/api-conventions”

What it can do on your machine

Read from SKILL.md and the folder at commit 2147848. 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 typescript).

    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 Conventions loads about 655 tokens when it runs. Until then it costs about 67 tokens; SKILL.md has 285 words of instructions outside code blocks.

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

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 willdady/platypus at commit 2147848, republished under its MIT licence (© willdady). 285 words, ~655 tokens.

Download SKILL.mdSave it as .claude/skills/api-conventions/SKILL.md (or your agent's skills folder).
name
api-conventions
description
Response-body conventions for the Platypus backend API — the `error` key for failures, the `message` key for 2xx status messages, and when to throw a typed error instead of returning a response. Use when adding or changing a backend route or its tests.

API Response Conventions

The two keys

error carries a failure. message carries a 2xx status line for an operation that has no resource to return.

typescript
return c.json({ error: "Workspace not found" }, 404);
return c.json({ message: "Board deleted" });

Never message on a 4xx/5xx — that is the one crossing the codebase does not make.

A delete or action with nothing to return answers 200 { message } — never a bodiless 204, and never { success: true }.

The error seam

Five cross-cutting failures are thrown, not returned. A single onError seam maps each to its status and emits the same { error } body, so a domain rule states its message once instead of once per caller:

ThrowBecomes
NotFoundError404
ValidationError400
LockedError403
ConflictError409
UnsupportedError501

A Postgres unique violation also maps to 409 — detect it through the shared helper rather than re-reading the driver's error shape. So does a foreign-key violation, as a backstop only: a delete guarded by a restrict reference should throw a ConflictError naming what still uses the row first.

typescript
if (!row) throw new NotFoundError("Card not found");
throw new ValidationError("Invalid user assignee");

A resource referenced in the request body that isn't in this Organization, or isn't Shared, is a NotFoundError (404) naming what couldn't be used — not a 422, and no extra detail fields beside error.

Throwing is what lets one rule serve more than one surface: the Kanban rules answer both the HTTP routes and the Agent tool set from a single place. Reach for the seam whenever the failure is one of those five; a 4xx that only one route can produce still answers inline with c.json({ error }, status). Both are current and roughly equally common — the seam is not a migration you should finish.

Test assertions

Assert against the key the response actually uses:

typescript
expect(body.error).toBe("Invalid user assignee");
expect(await res.json()).toEqual({ message: "Board deleted" });

A service test covering a thrown failure asserts the error, not a body:

typescript
await expect(fn()).rejects.toThrow(NotFoundError);

© willdady, 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 .agents/skills/api-conventions of willdady/platypus.

Open the folder on GitHubat commit 2147848

Compare with similar skills

API Conventions 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 Conventions compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
API Conventions this skillwilldady/platypus116—~655Automated safety check: PassMIT
Agent Browserquran/quran.com-frontend-next1.9k41 repos~3.3kAutomated safety check: PassNone
Process Inboxtelegramdesktop/tdesktop33k2 repos~4.5kAutomated safety check: PassGPL-3.0
Perform Tasktelegramdesktop/tdesktop33k2 repos~3kAutomated safety check: PassGPL-3.0
Brave Searchbadlogic/pi-skills2.6k6 repos~592Automated safety check: PassMIT
Continuetelegramdesktop/tdesktop33k2 repos~9.4kAutomated safety check: PassGPL-3.0

Similar skills

  • Agent Browser

    quran/quran.com-frontend-next

    Automates browser interactions for web testing, form filling, screenshots, and data extraction.

    1.9k GitHub starsUsed in 41 repos~3.3k tokens
    Productivity & AutomationAuto-check passed
  • Process Inbox

    telegramdesktop/tdesktop

    Process the local ignored ai-tdesktop inbox into durable, independently testable Telegram Desktop task records while task execution worktrees remain active.

    33k GitHub starsUsed in 2 repos~4.5k tokens
    Productivity & AutomationAuto-check passed
  • Perform Task

    telegramdesktop/tdesktop

    Resolve, start or resume, implement, review, test, and publish exactly one existing ai-tdesktop task by short slug or full dated id, including rare blocked retries and split-required results.

    33k GitHub starsUsed in 2 repos~3k tokens
    Productivity & AutomationAuto-check passed
  • Brave Search

    badlogic/pi-skills

    Web search and content extraction via Brave Search API. An agent skill from badlogic/pi-skills.

    2.6k GitHub starsUsed in 6 repos~592 tokens
    Productivity & AutomationAuto-check passed
  • Continue

    telegramdesktop/tdesktop

    Continue autonomous Telegram Desktop development from the shared ai-tdesktop repository.

    33k GitHub starsUsed in 2 repos~9.4k tokens
    Productivity & AutomationAuto-check passed
  • Garden Inbox

    paperclipai/paperclip

    Scan a Paperclip user's Mine inbox, classify reversible archive candidates, request checkbox confirmation, and archive only accepted selections.

    98k GitHub stars~1.1k tokensUpdated today
    Productivity & AutomationAuto-check passed

More from willdady/platypus

  • Platypus Tools

    willdady/platypus

    Platypus tools and tool sets — writing a tool, contributing a tool set from a plugin, scoping tools to a workspace, sharing a tool across sets, chat icons, and custom tool UI.

    116 GitHub stars~1.7k tokensUpdated today
    Auto-check passed
  • Add API Endpoint

    willdady/platypus

    Guide for adding new API endpoints to the Platypus backend using Hono.js — routing, tenant scoping middleware, validation, and database access.

    116 GitHub stars~955 tokensUpdated today
    Auto-check passed
  • Database Schema Changes

    willdady/platypus

    Guide for making database schema changes in Platypus using Drizzle ORM — editing the schema, pushing to a dev database, and generating the migration that ships.

    116 GitHub stars~527 tokensUpdated today
    Auto-check passed
  • Docs Audit

    willdady/platypus

    Audit one section of the docs content against the code, and report what is wrong, stale, fragile, off-voice, or missing.

    116 GitHub stars~1.2k tokensUpdated today
    Auto-check passed
  • Form Conventions

    willdady/platypus

    Post-save conventions for Platypus frontend forms — where a save lands the user, and what the submit button is called.

    116 GitHub stars~916 tokensUpdated today
    Auto-check passed
  • Pre Release Check

    willdady/platypus

    The final gate before a release is cut — go green, reconcile the release PR against what actually landed, sweep what CI can't see, check the roadmap and ADR statuses, optionally deep-review, then…

    116 GitHub stars~3.1k tokensUpdated today
    Auto-check passed

Questions about API Conventions

What does API Conventions do?

Response-body conventions for the Platypus backend API — the error key for failures, the message key for 2xx status messages, and when to throw a typed error instead of returning a response. API Conventions is an agent skill from willdady/platypus. Response-body conventions for the Platypus backend API — the error key for failures, the message key for 2xx status messages, and when to throw a typed error instead of returning a response.

When should I use API Conventions?

API Conventions fits situations like: changing a backend route.

How do I install API Conventions in Claude Code?

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

How do I install API Conventions in Codex?

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

Can I use API Conventions 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 willdady/platypus --skill api-conventions -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-conventions, .gemini/skills/api-conventions, .github/skills/api-conventions and .opencode/skills/api-conventions in your project.

What does API Conventions need to run?

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

Does API Conventions 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 Conventions 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 Conventions use?

API Conventions is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does API Conventions use?

About 655 tokens (SKILL.md is roughly 2.6k 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 Conventions?

Skills that share tags, products or a category with API Conventions: Agent Browser (quran/quran.com-frontend-next, 1.9k stars), Process Inbox (telegramdesktop/tdesktop, 33k stars), Perform Task (telegramdesktop/tdesktop, 33k stars) and Brave Search (badlogic/pi-skills, 2.6k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains API Conventions?

willdady (a GitHub user) maintains it in willdady/platypus, which has 116 GitHub stars. The repository holds 7 skills in this directory. The repository was last updated on October 7, 2026.

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