docs-status

A command that checks the health of a project's documentation. It looks for common files such as README.md and LICENSE, checks documentation comments in source code, and warns when docs may be older than the code.

In plain words
What is it for?
Use it to inspect documentation coverage and freshness, find missing files, and get recommendations for improving project docs.
Why use it?
It replaces manual checks for missing, incomplete, or outdated documentation with one project review.

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/nxtg-ai/forge-plugin/docs-status
Clone the repo
git clone --depth 1 https://github.com/nxtg-ai/forge-plugin
Per session 0 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 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.00000 $0.01002
Opus 5 $0.00000 $0.00501
Sonnet 5 $0.00000 $0.00200
Haiku 4.5 $0.00000 $0.00100

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

Security

Grade A, and why

docs-status 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.

docs/commands/docs-status.md · 116 lines

How it starts

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

/forge:docs-status

Show documentation health at a glance -- key files, source code JSDoc coverage, freshness, and actionable recommendations.

Level L1 Vibe Coder
Category Documentation
Syntax /forge:docs-status

What It Does

/forge:docs-status answers the question "how is our documentation?" in under a minute. It checks for essential files (README.md, CHANGELOG.md, CONTRIBUTING.md, LICENSE), counts files in the docs directory, measures JSDoc coverage on exported symbols in source code, and compares documentation freshness against source code modification times.

The freshness check is particularly valuable: if source files have been modified more recently than documentation files, it warns you that docs may be stale. This catches the common scenario where features evolve but documentation falls behind, creating a mismatch between what the docs say and what the code does.

Without this command, assessing documentation health means manually checking whether key files exist, grep-searching for JSDoc comments, and comparing file timestamps. /forge:docs-status automates all of that and ends with prioritized recommendations and links to the deeper docs commands.

Syntax & Options

/forge:docs-status

This command takes no arguments. It always runs the full documentation health check.

When to Use It

  • Before a release: Verify that documentation is current before shipping.
  • New contributor onboarding: Check whether the project has the documentation a new contributor would need (README, CONTRIBUTING, etc.).
  • Weekly documentation review: Quick pulse check on documentation health.

For detailed quality auditing with link validation and code example checking, use /forge:docs-audit. For automatically fixing stale documentation, use /forge:docs-update.

Examples

Example 1: Standard Documentation Status

/forge:docs-status
DOCUMENTATION STATUS
======================

Key Files:
  README.md:       EXISTS
  CHANGELOG.md:    EXISTS
  CONTRIBUTING.md:  MISSING
  LICENSE:         EXISTS

Documentation Directory:
  docs/ files: 5
    docs/API.md
    docs/ARCHITECTURE.md
    docs/DEPLOYMENT.md
    docs/DEVELOPMENT.md
    docs/TESTING.md

Source Documentation:
  Exported symbols: 87
  With JSDoc: 52
  Without JSDoc: 35
  Coverage: 59.8%

Freshness:
  Docs last updated: 3 days ago
  Source last updated: 2 hours ago
  WARNING: Source is newer than docs -- documentation may be stale

Recommendations:
  1. Add CONTRIBUTING.md for new contributors
  2. Add JSDoc to 35 undocumented exports (run /forge:docs-update --jsdoc)

---
Actions:
  /forge:docs-audit    Detailed documentation audit
  /forge:docs-update   Update stale documentation

Read the full file on GitHub · 116 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 · 116 lines · 0 tokens per session scan A 12602574a9f2

Subscribe to this mod's changes

docs-status is a command published in the GitHub repository nxtg-ai/forge-plugin (5 stars, last pushed 12d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,002 tokens. 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.