Borrowing it
Nothing to install: this file belongs to AsiaOstrich/EngramGraph. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/AsiaOstrich/EngramGraph/main/.agents/skills/api-design-assistant/SKILL.mdgit clone --depth 1 https://github.com/AsiaOstrich/EngramGraphWrote 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/asiaostrich/engramgraph/api-design-assistant)<a href="https://agentmods.dev/skills/asiaostrich/engramgraph/api-design-assistant"><img src="https://agentmods.dev/badge/skills/asiaostrich/engramgraph/api-design-assistant/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/skills/asiaostrich/engramgraph/api-design-assistant"><img src="https://agentmods.dev/badge/skills/asiaostrich/engramgraph/api-design-assistant.svg" alt="Reviewed on agentmods" width="80" 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.1 | $0.00075 | $0.01161 |
| Opus 5.5 | $0.00030 | $0.00464 |
| Sonnet 5.5 | $0.00015 | $0.00232 |
| Haiku 4.5 | $0.00007 | $0.00116 |
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 14d 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.
How it starts
The opening of the file, as written. The whole thing — 121 lines — stays where its author put it; the contents beside it link to each section on GitHub.
API Design Assistant | API 設計助手
Guide API design following REST, GraphQL, and gRPC best practices.
引導 API 設計,遵循 REST、GraphQL 和 gRPC 最佳實踐。
Quick Reference — REST Conventions | 快速參考
HTTP Methods | HTTP 方法
| Method | Purpose | Idempotent | 用途 |
|---|---|---|---|
| GET | Read resource | Yes | 讀取資源 |
| POST | Create resource | No | 建立資源 |
| PUT | Replace resource | Yes | 替換資源 |
| PATCH | Partial update | No | 部分更新 |
| DELETE | Remove resource | Yes | 刪除資源 |
Status Codes | 狀態碼
| Code | Meaning | 說明 |
|---|---|---|
| 200 | OK | 成功 |
| 201 | Created | 已建立 |
| 204 | No Content | 無內容(刪除成功) |
| 400 | Bad Request | 請求格式錯誤 |
| 401 | Unauthorized | 未認證 |
| 403 | Forbidden | 無權限 |
| 404 | Not Found | 資源不存在 |
| 409 | Conflict | 資源衝突 |
| 422 | Unprocessable Entity | 驗證失敗 |
| 429 | Too Many Requests | 請求過多(限流) |
| 500 | Internal Server Error | 伺服器內部錯誤 |
URL Naming | URL 命名規則
| Pattern | Example | 說明 |
|---|---|---|
| Collection | /users |
資源集合 |
| Singleton | /users/{id} |
單一資源 |
| Sub-resource | /users/{id}/orders |
子資源 |
| Action | /users/{id}/activate |
動作(僅限 POST) |
Design Workflow | 設計工作流程
DEFINE ──► DESIGN ──► VALIDATE ──► DOCUMENT
1. Define — Identify Requirements | 定義需求
Clarify consumers, use cases, data models, and non-functional requirements.
釐清使用者、使用情境、資料模型和非功能性需求。
2. Design — Structure Endpoints | 設計端點
Apply RESTful conventions, define request/response schemas, plan versioning.
套用 RESTful 慣例、定義請求/回應 Schema、規劃版本策略。
3. Validate — Review Consistency | 驗證一致性
Check naming consistency, error format uniformity, pagination patterns.
檢查命名一致性、錯誤格式統一、分頁模式。
4. Document — Generate Specs | 產生文件
Produce OpenAPI/Swagger specs or GraphQL schema documentation.
產出 OpenAPI/Swagger 規格或 GraphQL Schema 文件。
Versioning Strategy | 版本策略
| Strategy | Example | Pros | 優點 |
|---|---|---|---|
| URL Path | /v1/users |
Simple, explicit | 簡單、明確 |
| Header | Accept: application/vnd.api+json;v=1 |
Clean URLs | URL 乾淨 |
| Query | /users?version=1 |
Easy to test | 容易測試 |
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.
- 14d ago First seen · 121 lines · 75 tokens per session scan A efb2d6c38460
api-design is a skill published in the GitHub repository AsiaOstrich/EngramGraph (3 stars, last pushed today), licensed MIT. It adds 75 tokens to every session and 1,161 once invoked, about $0.0003 per session on Opus 5.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-10-16.
Other skills, from other repositories
kivgraph
Use Kivgraph's local MCP server to search symbols, read their source, and follow references, dependencies, cross-repository consumers and graph status in the indexed code graph.
mushroom
Live graph memory for agents — query and create entities, derive relationships by rule, explain why two things are associated, read the graph at a past commit, ask what a change would do, and answer as one role. Trigger on: memory, remember, recall, relationship, entity, association, why are X and Y related, as of…
potpie-repo-baseline
Use when establishing, refreshing, or deeply understanding a repository's baseline memory in Potpie: purpose, application type, features, services/modules, environments, deploy shape, dependencies, API contracts, datastores, integrations, ownership, and explicit preferences. The harness reads authored and…
potpie-infra-architecture
Use for project infra and architecture context: environments, adapters, runtime configuration, deployments, service dependencies, datastores, API contracts, ownership, incidents, and dependency blast radius.
potpie-project-preferences
Use before writing, modifying, reviewing, refactoring, or testing code so repo/project preferences surface: error handling, file structure, frameworks, logging, dependency choices, testing, security, API style, and naming. Also use after code work when a reusable project preference should be recorded.
nornicdb-bolt-client
Drive NornicDB from a Bolt client (neo4j-go-driver/v5 or any other Neo4j Bolt driver). Use when classifying retryable vs permanent errors, sizing UNWIND/MERGE batch writes, configuring connection defaults, or implementing retry logic against NornicDB. NornicDB speaks the same wire as Neo4j 5; this skill calls out the…