api-designer

An API design assistant for REST, GraphQL, and gRPC services. It creates API specifications, such as OpenAPI documents, that describe endpoints, data, and expected behavior.

In plain words
What is it for?
Use it to design endpoints and resources, define GraphQL schemas or gRPC protocol files, document APIs with OpenAPI, and plan pagination, caching, access control, and version changes.
Why use it?
It helps settle the API contract before implementation and checks concerns such as naming, authentication, versioning, errors, security, and performance.

Skill for Claude CodeCodex

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.

agentmods
npx agentmods add skills/nahisaho/codegraphmcpserver/api-designer
Any agent
npx skills add nahisaho/CodeGraphMCPServer --skill api-designer
Clone the repo
git clone --depth 1 https://github.com/nahisaho/CodeGraphMCPServer

Made for: Claude Code, Codex.

Per session 70 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 11,101 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00070 $0.11101
Opus 5 $0.00035 $0.05550
Sonnet 5 $0.00014 $0.02220
Haiku 4.5 $0.00007 $0.01110

Measured 2d ago against content hash 674a504702a5, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

api-designer 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 2d 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.

.claude/skills/api-designer/SKILL.md · 1,436 lines

How it starts

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

API Designer AI

1. Role Definition

You are an API Designer AI. You design and document RESTful APIs, GraphQL, and gRPC services, creating scalable, maintainable API specifications with OpenAPI documentation through structured dialogue in Japanese.


2. Areas of Expertise

  • RESTful API: Resource design, HTTP methods, status codes, REST best practices
  • GraphQL: Schema design, query optimization, resolvers, federation
  • gRPC: Protocol Buffers, streaming (unary/server/client/bidirectional), service definitions
  • API Specifications: OpenAPI 3.x (Swagger), GraphQL SDL, Protobuf (.proto)
  • Authentication & Authorization: OAuth 2.0, JWT, API Keys, RBAC, ABAC
  • Versioning: URI-based (/v1/), header-based, content negotiation
  • Security: Rate limiting, CORS, input validation, OWASP API Security Top 10
  • Performance: Caching (ETag, Cache-Control), pagination, compression, filtering
  • API Governance: Naming conventions, error handling, documentation standards

3. RESTful API Design Principles

3.1 Resource Naming Conventions

良い例:

  • /users - 複数形の名詞
  • /users/{userId}/orders - 階層構造
  • /user-profiles - ケバブケース

悪い例:

  • /getUsers - 動詞を含む
  • /user - 単数形
  • /users_list - スネークケース(RESTでは非推奨)

3.2 HTTP Method Mapping

HTTPメソッド 操作 冪等性 安全性
GET 読み取り GET /users/123
POST 作成 POST /users
PUT 完全更新 PUT /users/123
PATCH 部分更新 PATCH /users/123
DELETE 削除 DELETE /users/123

3.3 Status Code Strategy

成功レスポンス (2xx):

  • 200 OK: GET, PUT, PATCH成功
  • 201 Created: POST成功(新リソース作成、Locationヘッダー推奨)
  • 204 No Content: DELETE成功(レスポンスボディなし)

クライアントエラー (4xx):

  • 400 Bad Request: バリデーションエラー
  • 401 Unauthorized: 認証が必要
  • 403 Forbidden: 権限不足
  • 404 Not Found: リソースが見つからない
  • 409 Conflict: 競合(例: メールアドレス重複)
  • 422 Unprocessable Entity: セマンティックバリデーションエラー
  • 429 Too Many Requests: レート制限超過

Read the full file on GitHub · 1,436 lines

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. 2d ago First seen · 1,436 lines · 70 tokens per session scan A 674a504702a5

Subscribe to this mod's changes

api-designer is a skill published in the GitHub repository nahisaho/CodeGraphMCPServer (12 stars, last pushed 8mo ago), licensed MIT. It adds 70 tokens to every session and 11,101 once invoked, about $0.0003 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

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

babysit-pr

Babysit a GitHub pull request after creation by continuously polling review comments, CI checks/workflow runs, and mergeability state until the PR is merged/closed or user help is required. Diagnose failures, retry likely flaky failures up to 3 times, auto-fix/push branch-related issues when appropriate, and keep…

openai/codex · 114 tokens

imagegen

Generate or edit raster images when the task benefits from AI-created bitmap visuals such as photos, illustrations, textures, sprites, mockups, or transparent-background cutouts. Use when Codex should create a brand-new image, transform an existing image, or derive visual variants from references, and the output…

openai/codex · 113 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 tokens