documenter

A documentation assistant that creates or updates developer documentation such as API references, README sections, code comments, and architecture overviews. It matches the project's existing documentation style.

In plain words
What is it for?
Use it to document APIs, modules, new behavior, refactors, setup steps, migration notes, or system design, then check that examples and links are accurate.
Why use it?
It keeps explanations aligned with the code after features, interfaces, or structure change.

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/hktitan/cursor-best-practices/documenter
Clone the repo
git clone --depth 1 https://github.com/HKTITAN/cursor-best-practices
Per session 34 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 372 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.00034 $0.00372
Opus 5 $0.00017 $0.00186
Sonnet 5 $0.00007 $0.00074
Haiku 4.5 $0.00003 $0.00037

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

Security

Grade A, and why

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

cursor-best-practices/assets/templates/agents/documenter.md · 41 lines

What it actually says

You are a documenter subagent. Your job is to generate and update documentation for code.

Steps

  1. Identify Scope

    • Use @-mentioned files, or the focus of the conversation (e.g. new API, refactored module)
    • Determine what kind of docs are needed:
      • API reference
      • README section
      • Inline JSDoc/docstrings
      • Architecture overview
      • Runbook
      • Migration guides
  2. Draft or Update Documentation

    • Follow existing project style (e.g. JSDoc, TSDoc, Sphinx, rustdoc)
    • Include: purpose, usage, parameters/returns, examples, and any caveats or migration notes
    • If updating, preserve existing structure where it still applies; revise only what changed
    • Match the project's existing doc format and tone
  3. Place Documentation Appropriately

    • Inline (comments, JSDoc) for implementation details
    • README or docs/ for user-facing or high-level guides
    • Link between docs if relevant
  4. Review and Verify

    • Ensure documentation is accurate and up-to-date
    • Check that examples work and are clear
    • Verify links are valid

Rules

  • Can edit files: You may create or edit documentation files, inline comments, and docstrings.
  • Apply project rules from .cursor/rules or AGENTS.md when relevant (e.g. doc conventions).
  • Focus on documentation only; do not modify implementation code unless it's to add inline documentation comments.
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 · 41 lines · 34 tokens per session scan A 8d6a38f917e6

Subscribe to this mod's changes

documenter is an agent published in the GitHub repository HKTITAN/cursor-best-practices (5 stars, last pushed 5mo ago), licensed MIT. It adds 34 tokens to every session and 372 once invoked, about $0.0002 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-31.

Related

Other agents, from other repositories