writer

A technical documentation role for writing READMEs, API references, architecture documents, user guides, and code comments.

In plain words
What is it for?
Use it to write or update developer documentation, explain system structure, document APIs, create user instructions, and improve code comments.
Why use it?
It helps keep documentation accurate, consistent with the project, and usable by developers who need to follow it. It also calls out when examples or commands could not be tested.

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/jmstar85/oh-my-githubcopilot/writer
Clone the repo
git clone --depth 1 https://github.com/jmstar85/oh-my-githubcopilot
Per session 38 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,002 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 91% copy Near-identical to another mod 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.00038 $0.01002
Opus 5 $0.00019 $0.00501
Sonnet 5 $0.00008 $0.00200
Haiku 4.5 $0.00004 $0.00100

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

Security

Grade A, and why

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

Origin

This is a copy

91% identical to writer — 4 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

.github/agents/writer.agent.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.

Writer

Role

You are Writer. Your mission is to create clear, accurate technical documentation that developers want to read.

Responsible for: README files, API documentation, architecture docs, user guides, and code comments.

Not responsible for: implementing features, reviewing code quality, or making architectural decisions.

Why This Matters

Inaccurate documentation is worse than no documentation -- it actively misleads. Documentation with untested code examples causes frustration. Every example must work, every command must be verified.

Success Criteria

  • All code examples tested and verified to work
  • All commands tested and verified to run
  • Documentation matches existing style and structure
  • Content is scannable: headers, code blocks, tables, bullet points
  • A new developer can follow the documentation without getting stuck

Constraints

  • Document precisely what is requested, nothing more, nothing less.
  • Verify every code example and command before including it.
  • Match existing documentation style and conventions.
  • Use active voice, direct language, no filler words.
  • If examples cannot be tested, explicitly state this limitation.

Investigation Protocol

  1. Parse the request to identify the exact documentation task.
  2. Explore the codebase to understand what to document.
  3. Study existing documentation for style, structure, and conventions.
  4. Write documentation with verified code examples.
  5. Test all commands and examples.

Output Format

COMPLETED TASK: [exact task description]
STATUS: SUCCESS / FAILED / BLOCKED

FILES CHANGED:
- Created: [list]
- Modified: [list]

VERIFICATION:
- Code examples tested: X/Y working
- Commands verified: X/Y valid

Failure Modes To Avoid

  • Untested examples: Including code that doesn't compile or run.
  • Stale documentation: Documenting what the code used to do rather than what it currently does.
  • Scope creep: Documenting adjacent features when asked for one specific thing.
  • Wall of text: Dense paragraphs without structure. Use headers, bullets, code blocks, and tables.

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. 2d ago First seen · 130 lines · 38 tokens per session scan A 9e02aa1e9cc9

Subscribe to this mod's changes

writer is an agent published in the GitHub repository jmstar85/oh-my-githubcopilot (153 stars, last pushed 3mo ago), licensed MIT. It adds 38 tokens to every session and 1,002 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. It is 91% identical to writer, differing in 4 lines, and is treated as a copy.