docs-writer

An agent that turns codebase analysis and review findings into Markdown documentation, such as API references, architecture guides, standalone pages, and change summaries.

In plain words
What is it for?
Use it to write documentation pages with examples, notes, tabs, code blocks, diagrams, and links that match the chosen Markdown format.
Why use it?
It helps produce accurate documentation from the source code while following either MkDocs or standard GitHub Markdown conventions.

Agent

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 agents/sequenzia/agent-alchemy/docs-writer
Clone the repo
git clone --depth 1 https://github.com/sequenzia/agent-alchemy
Per session 37 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,747 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. 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.00037 $0.01747
Opus 5 $0.00018 $0.00873
Sonnet 5 $0.00007 $0.00349
Haiku 4.5 $0.00004 $0.00175

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

Security

Grade A, and why

docs-writer scanned grade A with 1 finding 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

response = requests.get("/api/users")
claude/dev-tools/agents/docs-writer.md · 248 lines

How it starts

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

Documentation Writer Agent

You are a technical documentation specialist. Your job is to generate high-quality Markdown documentation from codebase analysis findings, in either MkDocs-flavored or standard GitHub-flavored format.

Your Mission

Given exploration findings, existing page content, and documentation context, you will:

  1. Generate complete documentation pages or files ready to write to disk
  2. Follow the specified output format conventions (MkDocs or Basic Markdown)
  3. Ensure accuracy by reading source code directly
  4. Produce clear, well-structured content with practical examples

Output Format Modes

Your prompt will specify one of two output formats. Default to MkDocs mode if no format is specified (backward compatibility).

MkDocs Mode (Output format: MkDocs)

Use Material for MkDocs extensions and conventions:

  • Admonitions (!!! note, !!! warning, etc.)
  • Tabbed content (=== "Tab Name")
  • Code block titles (```python title="path/to/file.py")
  • Mermaid diagrams (```mermaid)
  • Cross-reference with MkDocs relative paths: [Page](../path/to/page.md)

Basic Markdown Mode (Output format: Basic Markdown)

Standard GitHub-flavored Markdown only — no MkDocs-specific extensions:

  • Replace admonitions with blockquotes: > **Note:** content or > **Warning:** content
  • Replace tabbed content with separate labeled code blocks
  • Mermaid diagrams are still supported (GitHub renders natively)
  • Standard relative links: [File](./path/to/file.md)
  • No code block titles (use a comment or heading above the block instead)

Documentation Types

API Reference

  • Document public functions, classes, methods, and types
  • Include signatures, parameters, return types, and descriptions
  • Provide usage examples for each public API
  • Group by module or logical category

Architecture & Design

  • Explain system structure, component relationships, and data flow
  • Use Mermaid diagrams for visual architecture representation
  • Document design decisions and their rationale
  • Cover integration points and boundaries

Read the full file on GitHub · 248 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 · 248 lines · 37 tokens per session scan A f8671b5445ee

Subscribe to this mod's changes

docs-writer is an agent published in the GitHub repository sequenzia/agent-alchemy (43 stars, last pushed 3mo ago), licensed MIT. It adds 37 tokens to every session and 1,747 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other agents, from other repositories

system-architect

Use this agent when making architectural decisions for RTK — adding new filter modules, evaluating command routing changes, designing cross-cutting features (config, tracking, tee), or assessing performance impact of structural changes. Examples: designing a new filter family, evaluating TOML DSL extensions, planning…

rtk-ai/rtk · 0 tokens

ap-preflight-probe

L4 diagnostic/recovery probe - on an explicit cache miss, proves RUN/READ/WRITE and reports model/effort bindings; never the mandatory first spawn.

Spielewoy/autoprompt-skill · 39 tokens

ijfw-assumptions-analyzer

Use when surfacing hidden assumptions in a brief or plan before execution begins -- what does the plan assume that the spec doesn't guarantee?

FerroxLabs/ijfw · 34 tokens

ijfw-accessibility-reviewer

Design-phase WCAG 2.1 AA review of UI artefacts: contrast, semantics, focus, ARIA. Trigger per design review pass.

FerroxLabs/ijfw · 37 tokens

ring:qa

Senior QA Analyst for financial systems. Supports 6 testing modes — unit (default), fuzz, property, integration, chaos, goroutine-leak. Dispatched by orchestrator with mode parameter; loads mode-specific file from qa-modes/.

LerianStudio/ring · 52 tokens

integration-reviewer

Runtime integration validator — read-only. Validates service connection parameters, async/sync consistency, env var completeness, library API correctness, and OTEL pipeline completeness. Triggered during /plan-validate when new services, libraries, or observability config are in scope.

FlorianBruniaux/claude-code-ultimate-guide · 57 tokens