api-documenter

A documentation helper that creates concise API references from route handlers and data models. An API is a set of program endpoints that other software can call.

In plain words
What is it for?
Use it to document or update API routes, payloads, validation rules, compatibility notes, and realistic request-response examples.
Why use it?
It reduces the manual work of matching endpoints with their request and response data, including changed behavior and edge cases.

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/bitia-srl/bitia-vs-code-copilot-examples/api-documenter
Any agent
npx skills add bitia-srl/bitia-vs-code-copilot-examples --skill api-documenter
Clone the repo
git clone --depth 1 https://github.com/bitia-srl/bitia-vs-code-copilot-examples

Made for: Claude Code, Codex.

Per session 17 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 428 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.00017 $0.00428
Opus 5 $0.00009 $0.00214
Sonnet 5 $0.00003 $0.00086
Haiku 4.5 $0.00002 $0.00043

Measured yesterday against content hash 6b4945c5ce6b, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

api-documenter 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 yesterday.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/normalize_examples.py), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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.

exercises/05-skills/.github/skills/api-documenter/SKILL.md · 45 lines

What it actually says

API Documenter Skill

Use this skill when the user asks to document APIs, update endpoint references, or compare contract changes.

Responsibilities

  • Inspect endpoint definitions in ${input:target:src/}.
  • Extract request/response models from Python and .NET route/model files.
  • Produce concise docs suitable for engineers and reviewers.
  • Add edge cases and compatibility notes where behavior changed.

Required workflow

  1. Read src/routes.py and src/dotnet/CourseEndpoints.cs and identify all routes.
  2. Read model definitions in src/models.py and src/dotnet/CourseDtos.cs and map them to request/response payloads.
  3. Use templates/openapi-summary.md for endpoint-level structure.
  4. Use examples/request-response.json for realistic payload examples.
  5. If requested, run scripts/normalize_examples.py to normalize example JSON before embedding.
  6. Update or generate docs/API_REFERENCE.md and/or docs/API_REFERENCE_DOTNET.md with:
    • endpoint table,
    • request and response sections,
    • validation/edge-case notes,
    • short migration notes when contracts changed.

Output format rules

  • Keep each endpoint section under 12 lines when possible.
  • Use explicit field names and types.
  • Avoid vague statements like "valid input required".
  • Include at least one failure mode per write endpoint.

Example invocation

  • "Use api-documenter to fully update docs/API_REFERENCE.md from src/routes.py and src/models.py."
  • "Use api-documenter to update docs/API_REFERENCE_DOTNET.md from src/dotnet/CourseEndpoints.cs and src/dotnet/CourseDtos.cs."

Included resources

  • templates/openapi-summary.md
  • examples/request-response.json
  • examples/before-after.md
  • scripts/normalize_examples.py
Files

What ships with it

4 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. yesterday First seen · 45 lines · 17 tokens per session scan A 6b4945c5ce6b

Subscribe to this mod's changes

api-documenter is a skill published in the GitHub repository bitia-srl/bitia-vs-code-copilot-examples (2 stars, last pushed 6mo ago), licensed MIT. It adds 17 tokens to every session and 428 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-08-31.

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

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 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

agent-host-chat-contributions

Build and review cross-cutting agent-host chat behavior through lifecycle contributions. Use when adding turn lifecycle side effects, prompt or context injection, restored-history transformation, protocol-action observation, or when reviewing changes that add code to AgentSideEffects or AgentService.

microsoft/vscode · 56 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens