fastapi-document skillA
fastapi-document is agent-read markdown (skill) from steph-dove/klaussy-agents: Use when the user wants documentation written or updated — docstrings, API docs, a README section, or a doc comment on a tricky piece of code. Documents selectively: what a reader genuinely can't infer from the code, and nothing they can. Writes prose, not code changes. Also known as `klaussy-document`..
Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.
What the file says
Add documentation where it earns its place, and only there. The hard part of this skill is restraint: most code does not need a comment, and a docstring that restates the signature is worse than none — it rots, and it trains readers to skip comments. Document the *why* and the non-obvious; never the *what* the code already shows. ## Phase 1: Decide what actually needs documenting 1. **Read the target** — the file, module, or diff the user named (default to the current change if they named nothing). Read enough of the surrounding code to know what a reader could already infer. 2. **Match the repo's existing doc style.** Read a few already-documented files: docstring convention (Google / NumPy / reST / JSDoc / TSDoc), whether public APIs carry docstrings, how module headers look. Match it exactly — don't introduce a new style. 3. **Select ruthlessly.** Document something only if it clears this bar: - **Public API surface** — an exported function/class/module whose contract (params, return, raises, side effects) a caller needs and can't see from the body. …
Read the whole file at its exact version.
How to install
mdr add steph-dove/klaussy-agents/fastapi-document@git:20260922.549c04fmdr add steph-dove/klaussy-agents/fastapi-document@sha256:1a6138972131a9ebPin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.
[](https://markdownregistry.com/a/art_wknwlkkcsuwchot3)
1 badge views in 30 days
Versions
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260922.549c04f latest | 2026-09-22 | 549c04f | 4,838 B | A | view · diff |
| git:20260918.4ac7924 | 2026-09-18 | 4ac7924 | 15,570 B | A | view · diff |
| git:20260918.e529a80 | 2026-09-18 | e529a80 | 15,536 B | A | view · diff |
| git:20260716.30d2fb1 | 2026-07-16 | 30d2fb1 | 9,119 B | A | view · diff |
| git:20260713.91029df | 2026-07-13 | 91029df | 7,073 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 (4838 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
steph-dove/klaussy-agents · 16 stars · license MIT · pushed 2026-09-24 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_wknwlkkcsuwchot3 GET https://markdownregistry.com/api/v1/resolve?ref=steph-dove/klaussy-agents/fastapi-document GET https://markdownregistry.com/api/v1/blob/1a6138972131a9eb34c5fe4eef880fe503943a8e33319c785aa5a124f0266772
Your agent 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.