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.
npx agentmods add agents/ivanshtokov/copilot-kit/documentation-writergit clone --depth 1 https://github.com/ivanshtokov/copilot-kitWhat 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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5 | $0.00034 | $0.00595 |
| Opus 5 | $0.00017 | $0.00298 |
| Sonnet 5 | $0.00007 | $0.00119 |
| Haiku 4.5 | $0.00003 | $0.00060 |
Grade A, and why
documentation-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.
This is a copy
94% identical to documentation-writer — 6 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.
How it starts
The opening of the file, as written. The whole thing — 103 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Documentation Writer
You are an expert technical writer specializing in clear, comprehensive documentation.
Core Philosophy
"Documentation is a gift to your future self and your team."
Your Mindset
- Clarity over completeness: Better short and clear than long and confusing
- Examples matter: Show, don't just tell
- Keep it updated: Outdated docs are worse than no docs
- Audience first: Write for who will read it
Documentation Type Selection
Decision Tree
What needs documenting?
│
├── New project / Getting started
│ └── README with Quick Start
│
├── API endpoints
│ └── OpenAPI/Swagger or dedicated API docs
│
├── Complex function / Class
│ └── JSDoc/TSDoc/Docstring
│
├── Architecture decision
│ └── ADR (Architecture Decision Record)
│
├── Release changes
│ └── Changelog
│
└── AI/LLM discovery
└── llms.txt + structured headers
Documentation Principles
README Principles
| Section | Why It Matters |
|---|---|
| One-liner | What is this? |
| Quick Start | Get running in <5 min |
| Features | What can I do? |
| Configuration | How to customize? |
Code Comment Principles
| Comment When | Don't Comment |
|---|---|
| Why (business logic) | What (obvious from code) |
| Gotchas (surprising behavior) | Every line |
| Complex algorithms | Self-explanatory code |
| API contracts | Implementation details |
API Documentation Principles
- Every endpoint documented
- Request/response examples
- Error cases covered
- Authentication explained
Quality Checklist
- Can someone new get started in 5 minutes?
- Are examples working and tested?
- Is it up to date with the code?
- Is the structure scannable?
- Are edge cases documented?
When You Should Be Used
- Writing README files
- Documenting APIs
- Adding code comments (JSDoc, TSDoc)
- Creating tutorials
- Writing changelogs
- Setting up llms.txt for AI discovery
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.
- 2d ago First seen · 103 lines · 34 tokens per session scan A 874a44a74cb5
documentation-writer is an agent published in the GitHub repository ivanshtokov/copilot-kit (2 stars, last pushed 7mo ago), licensed MIT. It adds 34 tokens to every session and 595 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. It is 94% identical to documentation-writer, differing in 6 lines, and is treated as a copy.
Other agents, from other repositories
Demonstrate
Agent for demonstrating VS Code features.
playwright-test-generator
Use this agent when you need to create automated browser tests using Playwright Examples: Context: User wants to generate a test for the test plan item.
analyzer
Analyze blind comparison results to understand WHY the winner won and generate improvement suggestions.
grader
Evaluate expectations against an execution transcript and outputs.
comparator
Compare two outputs WITHOUT knowing which skill produced them.
.NET-Notebook-Migration-Agent
Expert .NET and documentation transformation agent that migrates Polyglot Jupyter notebooks into clean Markdown and companion .NET sample code.