documentation-auditor

documentation-auditor is an agent for Claude Code from stilero/claude-plugins. It costs 48 tokens per session (570 once invoked), scanned A, original, MIT.

A codebase reviewer that looks for missing, outdated, or inconsistent documentation.

In plain words
What is it for?
Use it to check API descriptions, READMEs, JSDoc comments, architecture decision records, examples, and setup instructions.
Why use it?
It finds documentation problems that can make projects harder to start, operate, and maintain.

Agent for Claude Code

Written for Claude Code: shipped in a Claude Code plugin. Also seen: model in frontmatter.

Part of the tech-debt-audit plugin — 1 skill, 1 command, 9 agents shipped together

Good fit Use it to check API descriptions, READMEs, JSDoc comments, architecture decision records, examples, and setup instructions.

Compare 6 agents from other repositories ↓
Install with agentmods
npx agentmods add agents/stilero/claude-plugins/documentation-auditor
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.

Clone the repo
git clone --depth 1 https://github.com/stilero/claude-plugins

Made for: Claude Code.

Or install tech-debt-audit, the plugin that ships this one along with the rest of its 1 skill, 1 command, 9 agents.

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 documentation-auditor

README.md
[![agentmods](https://agentmods.dev/badge/agents/stilero/claude-plugins/documentation-auditor/github.svg)](https://agentmods.dev/agents/stilero/claude-plugins/documentation-auditor)
Your own site
<a href="https://agentmods.dev/agents/stilero/claude-plugins/documentation-auditor"><img src="https://agentmods.dev/badge/agents/stilero/claude-plugins/documentation-auditor/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 documentation-auditor

Your own site · 80×15
<a href="https://agentmods.dev/agents/stilero/claude-plugins/documentation-auditor"><img src="https://agentmods.dev/badge/agents/stilero/claude-plugins/documentation-auditor.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 48 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 570 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. 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.00048 $0.00570
Opus 5.5 $0.00019 $0.00228
Sonnet 5.5 $0.00010 $0.00114
Haiku 4.5 $0.00005 $0.00057

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

Security

Grade A, and why

documentation-auditor 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 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.

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.

plugins/tech-debt-audit/agents/documentation-auditor.md · 63 lines

How it starts

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

You are a documentation auditor. You find gaps where missing or stale documentation creates onboarding friction, operational risk, or maintenance burden.

What You Audit

API documentation

  • Endpoints without OpenAPI/Swagger annotations or schema definitions
  • Missing request/response type documentation
  • Undocumented query parameters, headers, or authentication requirements
  • API docs that don't match actual implementation

Stale documentation

  • README files referencing features, commands, or files that no longer exist
  • Documentation mentioning deprecated APIs or removed functionality
  • Setup instructions that don't match current dependencies or tooling
  • Architecture docs that don't reflect current structure

Missing inline documentation

  • Exported functions/types without JSDoc comments (focus on public API surfaces)
  • Complex algorithms or business logic without explanatory comments
  • Non-obvious workarounds or hacks without "why" comments
  • Configuration files without comments explaining non-default values

Architecture decision records

  • Major design decisions without corresponding ADRs
  • Existing ADRs that reference superseded decisions
  • Missing migration guides for deprecated patterns

Operational documentation

  • Missing or incomplete environment variable documentation
  • Missing deployment/runbook documentation
  • Missing incident response procedures for critical paths
  • Missing onboarding guide for new developers

How To Audit

  1. Read the main README and any docs/ directory for existing documentation
  2. Use Glob to find all documentation files: **/*.md, docs/**/*
  3. Cross-reference documented features with actual source files — do they still match?
  4. Use Grep to find exported functions without JSDoc: look for export function and check preceding lines
  5. Check for OpenAPI/Swagger annotations on route handlers
  6. Read .env.template or .env.example and compare with actual environment variable usage in the code
  7. Check for ADR directory and review coverage of major architectural decisions

Read the full file on GitHub · 63 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 · 63 lines · 48 tokens per session scan A 26ed6a2d1ffb

Subscribe to this mod's changes

documentation-auditor is an agent published in the GitHub repository stilero/claude-plugins (2 stars, last pushed 3mo ago), licensed MIT. It adds 48 tokens to every session and 570 once invoked, about $0.0002 per session on Opus 5.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

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.

microsoft/playwright · 151 tokens

.NET-Notebook-Migration-Agent

Expert .NET and documentation transformation agent that migrates Polyglot Jupyter notebooks into clean Markdown and companion .NET sample code.

microsoft/ai-agents-for-beginners · 33 tokens

code-reviewer

Performs thorough code reviews for the Notebooks in the Cookbook repo, focusing on Python/Jupyter best practices, and project-specific standards. Use this agent proactively after writing any significant code changes, especially when modifying notebooks, Github Actions, and scripts.

anthropics/claude-cookbooks · 52 tokens

AVM Owner Triage

Triage open GitHub issues across the Azure Verified Modules (AVM) repos an owner maintains. Splits the backlog into a Copilot-delegatable pile and a human pile, produces a report with a delegation ratio, and never comments or assigns without explicit user approval.

github/awesome-copilot · 61 tokens

Ultimate Transparent Thinking Beast Mode

Agent "Ultimate Transparent Thinking Beast Mode" from github/awesome-copilot, covering quantum cognitive architecture, phase 2: adversarial intelligence & red-team analysis, phase 3: implementation & iterative refinement and phase 4: comprehensive verification & completion.

github/awesome-copilot · 11 tokens

Context7-Expert

Expert in latest library versions, best practices, and correct syntax using up-to-date documentation.

github/awesome-copilot · 22 tokens