api-docs-generator SKILL.md skillA
api-docs-generator from mathews-tom/armory is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add mathews-tom/armory/api-docs-generator@v1.1.1Pins v1.1.1 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- mathews-tom/armory
- Path
skills/api-docs-generator/SKILL.md- Versions recorded
- 5
- Latest version
- v1.1.1, committed Apr 11, 2026
- First version recorded
- Mar 26, 2026
- Size
- 6,905 bytes
- Repository stars
- 334
- License
- MIT
Audits and enhances FastAPI and REST API documentation: missing descriptions, response codes, examples, docstrings, Pydantic models, OpenAPI spec. Triggers on: "generate API docs", "document this API", "OpenAPI for", "FastAPI docs", "document endpoints", "swagger docs".
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# 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 | …
Read the whole file at its exact version.
How to install
mdr add mathews-tom/armory/api-docs-generator@sha256:441c8f0f013ce204The line at the top of this page pins the label v1.1.1, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_3nxgxf3pxu74xeg4)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Mar 26, 2026 and Apr 11, 2026, about one every 4 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.1.1 latest | 2026-04-11 | 0aa221a | 6,905 B | A | view · diff |
| v1.1.1 | 2026-04-09 | 1cc63e5 | 7,248 B | B | view · diff |
| v1.1.1 | 2026-04-07 | b03849d | 7,234 B | B | view · diff |
| v1.1.0 | 2026-03-27 | d46cf2e | 7,234 B | B | view · diff |
| v1.1.0 | 2026-03-26 | 6fe71e6 | 7,231 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (6905 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
mathews-tom/armory · 334 stars · license MIT · pushed 2026-10-20 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_3nxgxf3pxu74xeg4 GET https://markdownregistry.com/api/v1/resolve?ref=mathews-tom/armory/api-docs-generator GET https://markdownregistry.com/api/v1/blob/441c8f0f013ce20464245c4ee10bb16e192526e0d5251cf35f5f297a78639447
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from mathews-tom/armory
Every file in mathews-tom/armory