api-docs-generator

A documentation tool for FastAPI and other REST APIs, which are web services that exchange data through defined URLs. It reviews endpoints and models, then improves their generated OpenAPI documentation.

In plain words
What is it for?
Use it to document routes, request and response models, status codes, examples, docstrings, and API specifications.
Why use it?
It fills in missing explanations, examples, and error details so developers can understand and use an API without reading all its source code.

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/mathews-tom/armory/api-docs-generator
Any agent
npx skills add Mathews-Tom/armory --skill api-docs-generator
Clone the repo
git clone --depth 1 https://github.com/Mathews-Tom/armory

Made for: Claude Code, Codex.

Per session 68 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,472 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.00068 $0.01472
Opus 5 $0.00034 $0.00736
Sonnet 5 $0.00014 $0.00294
Haiku 4.5 $0.00007 $0.00147

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

Security

Grade A, and why

api-docs-generator 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.

skills/api-docs-generator/SKILL.md · 166 lines

How it starts

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

API Docs Generator

Audits API endpoint documentation for completeness, generates enhanced docstrings with proper parameter descriptions and examples, documents all response codes, and produces Pydantic model examples — bridging the gap between auto-generated OpenAPI specs and genuinely useful API documentation.

Reference Files

File Contents Load When
references/fastapi-patterns.md FastAPI-specific documentation patterns, Path/Query/Body parameter docs FastAPI endpoint
references/example-generation.md Creating realistic field examples, model_config patterns Example values needed
references/response-codes.md Standard HTTP response documentation, error response schemas Response documentation needed
references/openapi-enhancement.md OpenAPI spec enrichment, tag organization, schema documentation OpenAPI spec review

Prerequisites

  • Access to the API source code (route definitions, models)
  • Framework identification (FastAPI, Flask, Django REST, Express)

Workflow

Phase 1: Analyze Endpoints

  1. Inventory endpoints — List all routes with HTTP method, path, handler function.
  2. Identify models — Request bodies (Pydantic models, dataclasses), response models, query parameters, path parameters.
  3. Map dependencies — Authentication requirements, middleware, shared dependencies.
  4. Read existing docs — Current docstrings, OpenAPI metadata, inline documentation.

Phase 2: Audit Documentation

For each endpoint, check:

Check What to Verify Common Gap
Endpoint description Handler has a docstring Missing or "TODO"
Parameter descriptions Each param has description= Path params undocumented
Request example Body model has example= or json_schema_extra No request example
Response model response_model= specified Returns raw dict
Error responses 4xx/5xx documented with responses= Only 200 documented
Tags Endpoint assigned to a tag group Untagged endpoints

Read the full file on GitHub · 166 lines

Files

What ships with it

5 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. 2d ago First seen · 166 lines · 68 tokens per session scan A 441c8f0f013c

Subscribe to this mod's changes

api-docs-generator is a skill published in the GitHub repository Mathews-Tom/armory (316 stars, last pushed 4d ago), licensed MIT. It adds 68 tokens to every session and 1,472 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

manager

Sync session work into GitHub issues, or query track status across repos. Write: find/update issue + W-label. Read: "что по ". Triggers: "создай issue", "синкни сессию", "manager". Not day/week plans (daily-tasks).

serejaris/personal-corp-os · 63 tokens

weekly-retro

Use when the user is closing an ISO week, reviewing planned outcomes against evidence, interviewing work Areas, resolving unfinished commitments, or asking for "ретро", "weekly retro", "week review", or lessons from the week.

serejaris/personal-corp-os · 49 tokens

art-director

Orchestrate iterative visual style searches with branch prompts, decision graphs, feedback loops, and final direction selection.

serejaris/personal-corp-os · 26 tokens

corp-doctor

Use when a Personal Corp operating loop needs setup, repair, a new department, or task routing: HQ files and agent rules, GitHub issue workflow, corp- owner map, department repositories, or deciding which repo an issue belongs to. Triggers: "corp doctor", "почини контур", "заведи отдел", "куда положить задачу"…

serejaris/personal-corp-os · 102 tokens

html-draft

Use when user wants a standalone HTML diagram in flat engineering blueprint style — architecture diagrams, system flows, technical spec sheets, component maps. Generates one HTML file using Tailwind v4 (browser CDN) for layout and D3 v7 (CDN) for SVG diagrams. User-invoked only — do NOT auto-trigger. Triggers on…

serejaris/personal-corp-os · 130 tokens

idea

Use when capturing ONE new idea the user voices and wants recorded — "save this idea", "I have an idea", "log this idea", "/idea", "idea: ...". Creates a provenance-tracked folder (one folder per idea) in your ideas repo, dedups against an index, optionally mirrors to a GitHub Project view filtered by label:idea. NOT…

serejaris/personal-corp-os · 135 tokens