dev-api-design

dev-api-design is a skill for Codex from vasilyu1983/AI-Agents-public. It costs 44 tokens per session (3,509 once invoked), scanned A, original, MIT.

A guide to designing API contracts, the agreed rules that let software systems communicate. It covers REST, GraphQL, gRPC, tRPC, AsyncAPI, webhooks, and interfaces for AI agents.

In plain words
What is it for?
Use it to specify or review APIs, choose an interface style, define request and response formats, and plan reliable service or event integrations.
Why use it?
It helps teams make clear decisions about authentication, versioning, errors, pagination, rate limits, and retries before implementation begins.

Skill for Codex

Written for Codex: agents/openai.yaml present. Also seen: mentions Claude Code; mentions Codex.

Good fit Use it to specify or review APIs, choose an interface style, define request and response formats, and plan reliable service or event integrations.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/vasilyu1983/ai-agents-public/dev-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 vasilyu1983/AI-Agents-public --skill dev-api-design
Clone the repo
git clone --depth 1 https://github.com/vasilyu1983/AI-Agents-public

Made for: 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 dev-api-design

README.md
[![agentmods](https://agentmods.dev/badge/skills/vasilyu1983/ai-agents-public/dev-api-design.svg)](https://agentmods.dev/skills/vasilyu1983/ai-agents-public/dev-api-design)
Your own site
<a href="https://agentmods.dev/skills/vasilyu1983/ai-agents-public/dev-api-design"><img src="https://agentmods.dev/badge/skills/vasilyu1983/ai-agents-public/dev-api-design.svg" alt="Measured on agentmods" height="20"></a>
Per session 44 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,509 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. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
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.00044 $0.03509
Opus 5 $0.00022 $0.01754
Sonnet 5 $0.00009 $0.00702
Haiku 4.5 $0.00004 $0.00351

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

Security

Grade A, and why

dev-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 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.

frameworks/shared-skills/skills/dev-api-design/SKILL.md · 171 lines

How it starts

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

API Design

Use this skill for contract-first API design across REST, GraphQL, gRPC, tRPC, AsyncAPI, and agent-facing interfaces. It owns contract choice, auth boundaries, versioning, errors, pagination, rate limits, idempotency, and validation; it does not replace backend implementation or security review.

Style Decision Table

API style Choose when Avoid when Canonical artifact
REST + OpenAPI Public APIs, broad tooling compatibility, cacheable resources Sub-10ms internal calls, streaming-first OpenAPI 3.2.0
GraphQL Complex client-driven query shapes, multi-team schema ownership Simple CRUD, caching is critical, single-team GraphQL SDL
gRPC Internal services, bidirectional streaming, type-critical boundaries Public internet consumers, browser-native clients protobuf
tRPC TypeScript monorepos with shared server+client Non-TS stacks, public third-party consumers TypeScript types
AsyncAPI + webhooks Event-driven contracts, pub/sub, push notifications Synchronous request-reply AsyncAPI 3.x
MCP tool layer Agent or LLM is the primary consumer Human-only clients MCP tool schema

Quick Reference

API style Load
REST + OpenAPI references/restful-design-patterns.md, references/openapi-guide.md
GraphQL references/graphql-patterns.md
gRPC references/grpc-patterns.md
tRPC references/trpc-patterns.md
AsyncAPI and webhooks references/asyncapi-patterns.md, references/webhook-patterns.md
Core cross-cutting references/error-handling-patterns.md, references/authentication-patterns.md, references/pagination-filtering.md, references/rate-limiting-patterns.md, references/api-testing-patterns.md

Read the full file on GitHub · 171 lines

Files

What ships with it

34 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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 Changed ed201a53266c
  2. 8d ago First seen · 171 lines · 44 tokens per session scan A b56af437dcd2

Subscribe to this mod's changes

dev-api-design is a skill published in the GitHub repository vasilyu1983/AI-Agents-public (86 stars, last pushed 5d ago), licensed MIT. It adds 44 tokens to every session and 3,509 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-30.

Related

Other skills, from other repositories

architecture-patterns

Implement proven backend architecture patterns including Clean Architecture, Hexagonal Architecture, and Domain-Driven Design. Use this skill when designing clean architecture for a new microservice, when refactoring a monolith to use bounded contexts, when implementing hexagonal or onion architecture patterns, or…

wshobson/agents · 65 tokens

saga-orchestration

Implement saga patterns for distributed transactions and cross-aggregate workflows. Use this skill when implementing distributed transactions across microservices where 2PC is unavailable, designing compensating actions for failed order workflows that span inventory, payment, and shipping services, building…

wshobson/agents · 91 tokens

fastapi-templates

Create production-ready FastAPI projects with async patterns, dependency injection, and comprehensive error handling. Use when building new FastAPI applications or setting up backend API projects.

wshobson/agents · 37 tokens

api-design-principles

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.

wshobson/agents · 44 tokens

event-store-design

Design and implement event stores for event-sourced systems. Use when building event sourcing infrastructure, choosing event store technologies, or implementing event persistence patterns.

wshobson/agents · 33 tokens

error-handling-patterns

Master error handling patterns across languages including exceptions, Result types, error propagation, and graceful degradation to build resilient applications. Use when implementing error handling, designing APIs, or improving application reliability.

wshobson/agents · 43 tokens