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.
npx agentmods add skills/yonatangross/orchestkit/api-designnpx skills add yonatangross/orchestkit --skill api-designgit clone --depth 1 https://github.com/yonatangross/orchestkitWrote 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.
[](https://agentmods.dev/skills/yonatangross/orchestkit/api-design)<a href="https://agentmods.dev/skills/yonatangross/orchestkit/api-design"><img src="https://agentmods.dev/badge/skills/yonatangross/orchestkit/api-design.svg" alt="Measured on agentmods" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5 | $0.00076 | $0.02716 |
| Opus 5 | $0.00038 | $0.01358 |
| Sonnet 5 | $0.00015 | $0.00543 |
| Haiku 4.5 | $0.00008 | $0.00272 |
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 today.
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.
How it starts
The opening of the file, as written. The whole thing — 260 lines — stays where its author put it; the contents beside it link to each section on GitHub.
API Design
Comprehensive API design patterns covering REST/GraphQL framework design, versioning strategies, and RFC 9457 error handling. Each category has individual rule files in rules/ loaded on-demand.
Quick Reference
| Category | Rules | Impact | When to Use |
|---|---|---|---|
| API Framework | 3 | HIGH | REST conventions, resource modeling, OpenAPI specifications |
| Versioning | 2 | HIGH | URL path versioning, header versioning; deprecation windows are house policy in references/ork-delta.md |
| Error Handling | 1 | HIGH | Agent-facing RFC 9457 extensions; base spec and FastAPI wiring are upstream |
| GraphQL | 2 | HIGH | Strawberry code-first, DataLoader, permissions, subscriptions |
| gRPC | 2 | HIGH | Protobuf services, streaming, interceptors, retry |
| Streaming | 2 | HIGH | SSE endpoints, WebSocket bidirectional, async generators |
| Integrations | 2 | HIGH | Messaging platforms (WhatsApp, Telegram), Payload CMS patterns |
Total: 14 rules across 7 categories. House decisions rescued from thinned files live in references/ork-delta.md; vendor and spec material is linked, not restated (see Upstream coverage).
API Framework
REST and GraphQL API design conventions for consistent, developer-friendly APIs.
| Rule | File | Key Pattern |
|---|---|---|
| REST Conventions | rules/framework-rest-conventions.md |
Plural nouns, HTTP methods, status codes, pagination |
| Resource Modeling | rules/framework-resource-modeling.md |
Hierarchical URLs, filtering, sorting, field selection |
| OpenAPI | rules/framework-openapi.md |
OpenAPI 3.1 specs, documentation, schema definitions |
Versioning
Strategies for API evolution without breaking clients.
| Rule | File | Key Pattern |
|---|---|---|
| URL Path | rules/versioning-url-path.md |
/api/v1/ prefix routing, version-specific schemas |
| Header | rules/versioning-header.md |
X-API-Version header, content negotiation |
What ships with it
32 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.
- assets/asyncapi-template.yaml 14 KB
- assets/openapi-template.yaml 14 KB
- examples/fastapi-problem-details.md 13 KB
- examples/orchestkit-api-design.md 14 KB
- metadata.json 414 B
- references/graphql-api.md 1.8 KB
- references/ork-delta.md 2.3 KB
- references/payload-vs-sanity.md 5.9 KB
- references/rest-patterns.md 14 KB
- references/telegram-bot-api.md 3.0 KB
- references/webhook-security.md 3.1 KB
- references/whatsapp-waha.md 2.7 KB
- rules/_sections.md 2.6 KB
- rules/_template.md 339 B
- rules/errors-agent-facing.md 8.3 KB
- rules/framework-openapi.md 4.8 KB
- rules/framework-resource-modeling.md 3.6 KB
- rules/framework-rest-conventions.md 3.2 KB
- rules/graphql-schema.md 2.9 KB
- rules/graphql-strawberry.md 2.5 KB
- rules/grpc-service.md 3.2 KB
- rules/grpc-streaming.md 3.1 KB
- rules/messaging-integrations.md 2.7 KB
- rules/payload-cms.md 2.9 KB
- rules/streaming-sse.md 3.2 KB
- rules/streaming-websocket.md 2.6 KB
- rules/versioning-header.md 3.5 KB
- rules/versioning-url-path.md 4.0 KB
- scripts/create-openapi-spec.md 2.0 KB
- scripts/fastapi-versioned-router.py 11 KB runs code
- scripts/problem-detail-exceptions.py 12 KB runs code
- test-cases.json 7.4 KB
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.
- today First seen · 260 lines · 76 tokens per session scan A 46f9a8c35b3f
api-design is a skill published in the GitHub repository yonatangross/orchestkit (225 stars, last pushed today), licensed MIT. It adds 76 tokens to every session and 2,716 once invoked, about $0.0004 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-03.
Other skills, from other repositories
api-design
Use when settling the contract of an API you expose, before implementation: resources/URLs, REST vs GraphQL, versioning, one RFC 9457 error envelope, pagination, idempotency — emitted as OpenAPI 3.1. NOT implementing the endpoints (that is fastapi/nestjs/go/nodejs), NOT auth hardening (that is secure-coding), NOT…
api-designer
Designs production-grade APIs — REST, GraphQL, gRPC, and AsyncAPI patterns including pagination, versioning, error handling, rate limiting, and API governance. Use when the user asks to design APIs, create endpoints, build an API layer, write OpenAPI specs, or needs help with REST/GraphQL/gRPC service design.
api-design
RESTful, GraphQL, gRPC, and API best practices.
api-design
Use when designing REST or GraphQL APIs, defining endpoints, implementing pagination/filtering, handling API versioning, or establishing API documentation with OpenAPI/Swagger.
api-design-patterns
Comprehensive REST and GraphQL API design patterns with versioning, pagination, error handling, and HATEOAS principles. Use when designing APIs, defining endpoints, or architecting service contracts requiring production-grade patterns.
create-tutorial
Scaffold a new Membrane API Gateway tutorial in the api-gateway repo — the numbered self-teaching YAML under distribution/tutorials/ /, its support files and README links, and the matching auto-discovered integration test. Use whenever the user asks to create, add, write, or scaffold a tutorial (or a tutorial step)…