StaleDocs

io.github.mr-min-maxPublished by GitHub account mr-min-maxv0.5.0-beta.2Updated Oct 30, 2026

Finds documentation that no longer matches your code. Deterministic AST check; no API key.

VerifiedSTDIODesktop onlyKnowledge & MemoryDeveloper Tools

Overview

AI-generated overview

StaleDocs detects documentation that no longer matches your code, using deterministic AST analysis, and hands the assistant the exact sections to update.

What you can do
  • Find documentation drift: report public API changes in a pull request and the doc sections that still describe the old behavior.
  • Inspect changed symbols: get before and after signatures for changed public symbols.
  • Prepare documentation updates: supply the exact sections and signatures so the assistant can draft and apply approved Markdown.
  • Audit a repository: list package scripts, paths and public class members that Markdown still mentions but the code no longer has, including agent instruction files.
When to use it
Useful when a repository's README, API docs or agent instruction files drift from the code, especially during pull request review or when you want an assistant to draft and validate documentation updates.
Requirements
Runs locally over stdio via npx from the npm package staledocs. Node.js 22.12.0 or newer and npm/npx are required for the plugin and CLI paths. No API key or authentication is needed for the core drift checks.
Before you install
The core review, check and audit commands are described as read-only and deterministic. The legacy readme, api, changelog, diagram and annotate generators need a provider key or Ollama, which sends code to that provider. The assistant applies documentation edits itself, so review its changes before committing.

Installation

In SourceWeft

  1. Open StaleDocs in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

StaleDocs

Formerly aidoc.

[StaleDocs: a createUser(email) change linked to README.md and docs/API.md, ending in a reviewed documentation update.]

StaleDocs reads your code, finds public API changes in a pull request, and tells you which documentation sections now describe the old behavior.

Website · GitHub Action setup · Codex plugin

Add to a repository in one file

yaml
name: StaleDocs reviewon: {pull_request: {types: [opened, synchronize, reopened]}}permissions: {contents: read, pull-requests: write}jobs:  review:    runs-on: ubuntu-latest    steps:      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1        with: {fetch-depth: 0}      - uses: mr-min-max/[email protected]        with:          mode: review          fail-on: none

[Example StaleDocs pull request review comment]

What the comment contains

  • Changed symbols with before and after signatures.
  • Sections that mention them and were not updated.
  • breaking-change and docs-stale labels when applicable.

No model, no API key, no writes. It is deterministic AST analysis.

From the terminal

Install the command:

bash
npm install -g staledocs

staledocs review reports documentation impact for a pull request.

staledocs plan prints the affected documentation targets.

staledocs check exits with code 1 when a section mentioning a changed public symbol was not updated, and exits 0 otherwise.

Audit a repository once

staledocs audit lists the package scripts, repository paths, and public class members that your Markdown still mentions but the code no longer has, including AGENTS.md, CLAUDE.md, and the copilot-instructions.md file under .github, the files coding agents read first. It needs no pull request. The command is new in 0.5.0-beta.1.

bash
npm install -g staledocsstaledocs audit

Output on a small fixture repository:

text
README.md > Usage: member-missing "Client.fetchAll"README.md > Usage: path-missing "src/core/old.ts"README.md > Usage: script-missing "npm run bulid" (closest: build)
3 findings across 1 Markdown file: script-missing 1, path-missing 1, member-missing 1.

Fix the docs with your assistant

Codex plugin

Start Codex in your Git worktree, then run:

bash
codex plugin marketplace add mr-min-max/staledocscodex plugin add staledocs@staledocs

In a new session, type $ and pick staledocs:check, staledocs:review, or staledocs:maintain-documentation (or open /skills). Requires Node.js >=22.12.0 and npm/npx. This repository hosts its own plugin marketplace; it is not a listing in OpenAI's plugin directory.

Claude Code plugin

Start Claude Code in your Git worktree, then run:

text
/plugin marketplace add mr-min-max/staledocs/plugin install staledocs@staledocs

Use /staledocs:check for drift signals, /staledocs:review for the PR report, or /staledocs:maintain-documentation for a validated draft. Requires Node.js >=22.12.0 and npm/npx. This repository hosts its own plugin marketplace; it is not an approved Anthropic directory listing.

Manual MCP

bash
codex mcp add staledocs -- staledocs --mcp

prepare_documentation_update gives the assistant the exact sections and before and after signatures.

StaleDocs validates the candidate, and the assistant applies the approved Markdown.

See the Codex guide and Claude guide.

Languages

TypeScript, JavaScript, and Python are supported. A public symbol is one reachable from the package entry; see LIMITATIONS.md for syntax and discovery caveats.

Legacy generators

readme, api, changelog, diagram, and annotate remain available for initial documentation. They need a provider key or Ollama and are not the focus of StaleDocs. See the CLI catalogue.

Status and links

StaleDocs 0.5.0-beta.2 is the current release. npm latest, npm beta, and the GitHub Action v0 tag point to the current release, and the official MCP Registry lists it as io.github.mr-min-max/staledocs.

[npm] [CI] [License: MIT] [Node.js] [GitHub Action Marketplace]

Source: README.md at commit 2eca54c

Tools

0
SourceWeft started this package once in an isolated sandbox, without credentials, to list its tools. That failed: the server did not start.

Version history

2
  1. v0.5.0-beta.2LatestOct 30, 2026
  2. v0.5.0-beta.1Oct 29, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts