document

A command that asks a technical-writing helper to create or update documentation such as a README, architecture record, overview, or code comment.

In plain words
What is it for?
Use it to document a code change, choose the right documentation format, match existing writing conventions, and prepare a draft or file change.
Why use it?
It keeps documentation tied to observed code behavior and records where factual claims came from.

Command

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 commands/lugassawan/swe-workbench/document
Clone the repo
git clone --depth 1 https://github.com/lugassawan/swe-workbench
Per session 24 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 451 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.00024 $0.00451
Opus 5 $0.00012 $0.00226
Sonnet 5 $0.00005 $0.00090
Haiku 4.5 $0.00002 $0.00045

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

Security

Grade A, and why

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

commands/document.md · 21 lines

What it actually says

Target: $ARGUMENTS

If $ARGUMENTS contains a ticket reference, invoke swe-workbench:ticket-context first and prepend its structured summary to the delegation context below. Skip if $ARGUMENTS is free-text with no recognizable ref. (Trigger patterns are defined in that skill's "When to invoke" section.)

Delegate to the swe-workbench:tech-writer subagent. Its output must include:

  1. Artifact type — which category (README section, ADR, ARCHITECTURE/OVERVIEW, inline comment).
  2. Target path — the exact file path the artifact will live at.
  3. Style notes detected — heading case, voice, list style, em-dash usage, and any other conventions observed in existing top-level docs.
  4. Draft or diff — the content to be written.
  5. Citations — commit hash or file:line for every factual claim in committed artifacts; conversation excerpt is acceptable only in drafts.

Absolute rule: never invent behavior. If the diff doesn't show it, don't document it.

Plan output: If you (the orchestrator) author a plan based on the subagent's response and that plan modifies the codebase (fix / make / implement) — whether saved to a plan file or passed to ExitPlanMode — first activate swe-workbench:workflow-development in Mode A and embed the rendered ## Workflow section in the plan per skills/workflow-development/templates/plan-workflow-section.md. Run the skill's project-detection (git branch -a, git log --oneline -20, Makefile grep, PR-template lookup) so the placeholders are substituted from this repo, not left as [[detect:…]]. Skip Mode A if the plan is pure analysis, design recommendation, or any output that does not introduce file edits — the Workflow section's phases (Branch / Verify / Deliver) do not apply.

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 · 21 lines · 24 tokens per session scan A b3fdfa871f63

Subscribe to this mod's changes

document is a command published in the GitHub repository lugassawan/swe-workbench (2 stars, last pushed yesterday), licensed MIT. It adds 24 tokens to every session and 451 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-31.