Project Documenter

Project Documenter is an agent for Claude Code from github/awesome-copilot. It costs 51 tokens per session (2,962 once invoked), scanned C, original, MIT.

A project-documentation assistant that examines a software repository and produces Markdown summaries, draw.io architecture diagrams, PNG images, and Microsoft Word documents. It identifies the project's technologies, components, data flow, and deployment model rather than assuming them.

In plain words
What is it for?
Use it to document projects, create architecture diagrams, prepare Confluence-ready material, and generate a Word document with embedded diagrams.
Why use it?
It turns an unfamiliar codebase into documentation that developers and teams can use to understand how the system is built.

Agent for Claude Code ✓ vendor

Written for Claude Code: a Claude Code subagent (agents/*.md). Also seen: mentions AGENTS.md.

Needs its repository: it runs a file that does not travel with it, so clone the repository first. The line is node skills/drawio/drawio-to-png.mjs --dir docs/diagrams.

Good fit Use it to document projects, create architecture diagrams, prepare Confluence-ready material, and generate a Word document with embedded diagrams.

Compare 5 agents from other repositories ↓
About the project

Awesome GitHub Copilot is a community collection of custom agents, instructions, skills, hooks, workflows, plugins, and configuration for GitHub Copilot. It helps Copilot users customize coding and development tasks. Catalogue entries are individual Copilot add-ons from this collection.

github/awesome-copilot · 40,159 stars · on GitHub

Install

Getting it into your agent

It runs from inside its repository, so the clone comes first — what it calls does not travel with the file alone.

Clone the repo
git clone --depth 1 https://github.com/github/awesome-copilot
agentmods
npx agentmods add agents/github/awesome-copilot/project-documenter

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for Project Documenter

README.md
[![agentmods](https://agentmods.dev/badge/agents/github/awesome-copilot/project-documenter/github.svg)](https://agentmods.dev/agents/github/awesome-copilot/project-documenter)
Your own site
<a href="https://agentmods.dev/agents/github/awesome-copilot/project-documenter"><img src="https://agentmods.dev/badge/agents/github/awesome-copilot/project-documenter/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for Project Documenter

Your own site · 80×15
<a href="https://agentmods.dev/agents/github/awesome-copilot/project-documenter"><img src="https://agentmods.dev/badge/agents/github/awesome-copilot/project-documenter.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 51 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 2,962 The whole file, excluding the scripts and references it only reads on demand.
Security scan C 1 finding. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00051 $0.02962
Opus 5.5 $0.00020 $0.01185
Sonnet 5.5 $0.00010 $0.00592
Haiku 4.5 $0.00005 $0.00296

Measured 1mo ago against content hash 120e1f4fdc61, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade C, and why

Project Documenter scanned grade C with 1 finding 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 1mo 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.

Hidden instructionshighPrompt injection

Directives inside HTML comments, invisible characters or bidirectional overrides are read by the model and not by the person reviewing the file.

<!-- External system -->
Origin

Copies of this mod

2 near-identical copies found in the catalogue:

agents/project-documenter.agent.md · 301 lines

How it starts

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

Project Documentation Agent

You are a documentation agent that generates professional, Confluence-ready project summaries for any software project. You automatically discover the project's technology stack, architecture, components, data flow, and deployment model by analyzing the codebase — then produce comprehensive documentation with architecture diagrams and a Word document with embedded images.

You are project-agnostic. You do not assume any specific language, framework, or architecture. You discover everything dynamically from the repository.

Before starting, check for these optional context sources (read them if they exist, skip if they don't):

  • Agents.md or AGENTS.md at the repository root — may contain authoritative service rules and contracts
  • README.md — project overview and setup instructions
  • ARCHITECTURE.md, docs/architecture.md, or similar — existing architecture documentation
  • .github/copilot-instructions.md — project-specific AI instructions

Purpose

This agent generates comprehensive project documentation with professional architecture diagrams and Word document output. It does NOT write, modify, or generate any production code. Its output is:

  1. Markdown document (docs/project-summary.md) — the source document
  2. Draw.io diagrams (docs/diagrams/*.drawio) — editable architecture diagrams
  3. PNG exports (docs/diagrams/*.drawio.png) — rendered diagram images
  4. Word document (docs/project-summary.docx) — professional .docx with embedded diagram images

This agent is a standalone utility — invoke it on any repository to produce or refresh project documentation.


Writing Framework

Diátaxis Framework

The generated document combines two Diátaxis quadrants:

  • Reference (primary) — information-oriented technical description of the project's machinery, contracts, and structure.
  • Explanation (secondary) — understanding-oriented discussion of how and why for pipeline, architecture decisions, and extension patterns.

Read the full file on GitHub · 301 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. 1mo ago First seen · 301 lines · 51 tokens per session scan C 120e1f4fdc61

Subscribe to this mod's changes

Project Documenter is an agent published in the GitHub repository github/awesome-copilot (40,159 stars, last pushed 3d ago), licensed MIT. It adds 51 tokens to every session and 2,962 once invoked, about $0.0002 per session on Opus 5.5. A static security scan graded it C with 1 finding (hidden instructions). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.