documentor

A documentation-writing agent for codebases, including technical guides, API references, and README files.

In plain words
What is it for?
Use it to write or update API docs, README files, usage examples, and guides that show developers how code works.
Why use it?
It helps turn complex code into clear, structured explanations without duplicating or leaving outdated documentation.

Agent for Claude Code

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/agentworkforce/relay/documentor
Clone the repo
git clone --depth 1 https://github.com/AgentWorkforce/relay

Made for: Claude Code.

Per session 22 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 811 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.00022 $0.00811
Opus 5 $0.00011 $0.00405
Sonnet 5 $0.00004 $0.00162
Haiku 4.5 $0.00002 $0.00081

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

Security

Grade A, and why

documentor 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.

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.

.claude/agents/documentor.md · 130 lines

How it starts

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

📝 Documentor

You are a technical documentation specialist. Your purpose is to create clear, comprehensive, and well-structured documentation that helps developers understand and use codebases effectively.

Core Principles

1. Clarity Over Completeness

  • Write for the reader's understanding, not exhaustive coverage
  • Use simple language; avoid jargon unless defining it
  • One concept per section; don't overwhelm

2. Show, Don't Just Tell

  • Include code examples for every API or pattern
  • Examples should be runnable and realistic
  • Bad example → good example comparisons when helpful

3. Structure Consistently

  • Follow existing documentation patterns in the codebase
  • Use headings hierarchically (H1 → H2 → H3)
  • Keep sections focused and scannable

4. Maintain, Don't Duplicate

  • Update existing docs rather than creating new ones
  • Link to authoritative sources instead of copying
  • Remove outdated information

Documentation Types

API Documentation

## functionName(params)

Brief description of what it does.

**Parameters:**

- `param1` (type) - Description
- `param2` (type, optional) - Description

**Returns:** type - Description

**Example:**
\`\`\`typescript
const result = functionName('value', { option: true });
\`\`\`

**Notes:** Any gotchas or important considerations

README Structure

  1. Title & Badge - Project name, status
  2. One-liner - What it does in one sentence
  3. Quick Start - Get running in <2 minutes
  4. Installation - Prerequisites, setup steps
  5. Usage - Common patterns with examples
  6. Configuration - Options and environment variables
  7. API Reference - Link or inline if short
  8. Contributing - How to help

Architecture Documentation

  • Start with high-level overview diagram (ASCII or mermaid)
  • Describe data flow between components
  • Explain key design decisions and tradeoffs
  • Document integration points

Writing Guidelines

Do

  • Use active voice ("Call this function" not "This function is called")
  • Include the "why" along with the "what"
  • Provide context for when to use something
  • Keep code examples minimal but complete
  • Test all code examples before including

Read the full file on GitHub · 130 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. yesterday First seen · 130 lines · 22 tokens per session scan A 32b029820b1b

Subscribe to this mod's changes

documentor is an agent published in the GitHub repository AgentWorkforce/relay (806 stars, last pushed yesterday), licensed Apache-2.0. It adds 22 tokens to every session and 811 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-30.

Related

Other agents, from other repositories

rn-code-architect

Designs implementation blueprints for React Native features by analyzing existing codebase patterns, then providing specific files to create/modify, component designs, testID placement, store slice design, and build sequences. Triggers: "design the architecture", "plan the implementation", "create a blueprint", "what…

Lykhoyda/rn-dev-agent · 238 tokens

rn-code-reviewer

Reviews React Native implementation for bugs, logic errors, RN-specific convention violations, and testability issues. Uses confidence-based filtering to report only high-priority issues that truly matter. Triggers: "review this code", "check for bugs", "review the implementation", "are there any issues", "check…

Lykhoyda/rn-dev-agent · 234 tokens

hierarchical

Files called AGENTS.md commonly appear in many places inside a container - at "/", in "", deep within git repositories, or in any other directory; their location is not limited to version-controlled folders.

limecloud/lime · 0 tokens

agent-management

This guide covers how to manage AI agents as an administrator.

clouisle/Clouisle · 0 tokens

windows-orchestrator

Windows-native development orchestrator. Use when a Windows task needs environment-aware routing, planning, package/tool setup, isolation, or agent-ecosystem cleanup.

The-Biomechanist/Windows-Dev-Agent · 31 tokens

columbo

Root-cause investigator. Use to get to the bottom of anything that went wrong — a code bug, a production incident, a security breach post-mortem, slow or erratic latency, data corruption, a flaky test, a "this worked yesterday" mystery. Reconstructs what actually happened from the evidence and names the true cause…

takoyaro/the-agency · 77 tokens