api-and-interface-design

api-and-interface-design is a skill for Claude Code, Codex from Plazmodium/odin-workflow. It costs 26 tokens per session (310 once invoked), scanned A, original, MIT.

A guide to designing stable boundaries between code, such as APIs, command-line tools, exported functions, events, schemas, and modules. It defines expected inputs, outputs, errors, side effects, and compatibility.

In plain words
What is it for?
Use it when creating or changing an API, CLI, schema, event, exported function, or module boundary, and when adding contract tests or examples for success and failure cases.
Why use it?
It reduces surprises for other programs and users by validating input, making errors predictable, and accounting for behavior that existing callers may already rely on.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it when creating or changing an API, CLI, schema, event, exported…

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/plazmodium/odin-workflow/api-and-interface-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 Plazmodium/odin-workflow --skill api-and-interface-design
Clone the repo
git clone --depth 1 https://github.com/Plazmodium/odin-workflow

Made for: Claude Code, Codex.

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

README.md
[![agentmods](https://agentmods.dev/badge/skills/plazmodium/odin-workflow/api-and-interface-design.svg)](https://agentmods.dev/skills/plazmodium/odin-workflow/api-and-interface-design)
Your own site
<a href="https://agentmods.dev/skills/plazmodium/odin-workflow/api-and-interface-design"><img src="https://agentmods.dev/badge/skills/plazmodium/odin-workflow/api-and-interface-design.svg" alt="Measured on agentmods" height="20"></a>
Per session 26 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 310 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.00026 $0.00310
Opus 5 $0.00013 $0.00155
Sonnet 5 $0.00005 $0.00062
Haiku 4.5 $0.00003 $0.00031

Measured 5d ago against content hash ff623d824a78, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

api-and-interface-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 5d 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.

agents/skills/workflow/api-and-interface-design/SKILL.md · 43 lines

What it actually says

api-and-interface-design

When To Use

  • Creating or changing an API, CLI, exported function, event, schema, or module boundary.
  • Behavior may be consumed by other code, users, scripts, or services.
  • Inputs cross a trust or version boundary.

Workflow

  1. Identify consumers and observable behavior.
  2. Define the contract before implementation: inputs, outputs, errors, side effects, and compatibility.
  3. Apply Hyrum's Law: assume every observable behavior may become depended on.
  4. Validate inputs at the boundary.
  5. Make illegal states unrepresentable where practical.
  6. Design error semantics that help callers recover.
  7. Add contract tests or examples for expected and failure paths.

Anti-Rationalization

Excuse Rebuttal
"This is internal." Internal APIs still gain consumers and implicit contracts.
"Callers should pass valid data." Boundaries must defend themselves.
"Changing this behavior is harmless." Observable behavior can have hidden dependents.

Verification

  • Contract is documented in code, tests, types, schema, or command help.
  • Invalid inputs fail predictably.
  • Compatibility risk is called out.

Exit Criteria

  • Consumers can rely on the interface without guessing behavior.
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. 5d ago First seen · 43 lines · 26 tokens per session scan A ff623d824a78

Subscribe to this mod's changes

api-and-interface-design is a skill published in the GitHub repository Plazmodium/odin-workflow (0 stars, last pushed 3mo ago), licensed MIT. It adds 26 tokens to every session and 310 once invoked, about $0.0001 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-09-01.

Related

Other skills, from other repositories

nornweave-api

Give AI agents their own email inboxes using the NornWeave API. Use when building email agents, sending/receiving emails programmatically, managing inboxes, retrieving threads, searching messages, or integrating with email providers (Mailgun, SES, SendGrid, Resend). NornWeave provides LLM-ready markdown parsing and…

DataCovey/nornweave · 77 tokens

cloudflare-worker-api

Structure Worker API routes and handlers. Use this skill when defining Cloudflare Worker routes, building response helpers, or implementing typed handler patterns — even if they just say "set up the worker routes" or "add an API endpoint to the worker". Auth belongs to secure-invite-and-access. Not for…

d-o-hub/github-template-ai-agents · 74 tokens

secure-invite-and-access

Implement access control, authentication, and authorization patterns. Use this skill when building auth endpoints, managing permissions, implementing session/token logic, or generating signed URLs — even if they just say "add auth" or "secure this endpoint". Generic template adaptable to any project's auth needs. Not…

d-o-hub/github-template-ai-agents · 73 tokens

spotify-exhaustive-feature-sweep

Exhaustive feature sweep across Spotify domains — enumerate all endpoints into quantity-first tool proposals with quota flags and batched GitHub logging.

NovaLux12/spotify-mcp-server · 34 tokens

coding-reference

Quick-reference coding standards and backend patterns for consistent development.

mattmre/EVOKORE-MCP-PUBLIC · 13 tokens

api-linter

MCP definition linter rules reference. Use when bun run lint:mcp or bun run devcheck reports a lint error or warning (format-parity, schema-is-object, name-format, server-json-, etc.) and you need to understand the rule, its severity, and how to fix it. Every rule ID the linter emits has an entry in this doc.

cyanheads/pubmed-mcp-server · 86 tokens