Skip to content
MCP server

StaleDocs

Flag README and docs sections that a pull request's API change left outdated

Runs locallyStatus and history
Install
Pricing
Open source
Platforms
CLI, Linux, macOS
Runs
Locally
Version
0.5.0-beta.2
Listing updated
3 days ago

About StaleDocs

StaleDocs is an open-source MCP server for developer tools. It runs locally on your machine and is started by your AI client.

StaleDocs compares a pull request's base and head commits, keeps only changes to the package's public boundary, and lists the Markdown sections that mention a changed symbol but were not updated. Signatures are parsed with an AST rather than guessed, so no model decides whether something changed. It needs no API key and never writes to the repository on its own.

The report shows changed symbols with before and after signatures, marks breaking changes and adds breaking-change and docs-stale labels. One command, audit, checks a whole repository for package scripts, paths and class members that Markdown still names but the code no longer has, including AGENTS.md and CLAUDE.md. Supported languages are TypeScript, JavaScript and Python.

It runs as a report-only GitHub Action, a CLI, or a Codex and Claude Code plugin whose maintain-documentation command lets the assistant draft a fix that StaleDocs validates first. Over MCP, prepare_documentation_update hands the assistant the exact sections and signatures. The site reports 7 of 10 agreements on external pull requests, says it checks API changes and not prose accuracy, and only maps docs that name the changed symbol. The current release is a beta.

Install

Run in a terminal

claude mcp add staledocs -- npx -y staledocs

Add to claude_desktop_config.json

{
  "mcpServers": {
    "staledocs": {
      "command": "npx",
      "args": [
        "-y",
        "staledocs"
      ]
    }
  }
}
Install in CursorOpens Cursor, which asks you to confirm. Or add it by hand:

Add to ~/.cursor/mcp.json

{
  "mcpServers": {
    "staledocs": {
      "command": "npx",
      "args": [
        "-y",
        "staledocs"
      ]
    }
  }
}
Install in VS CodeOpens VS Code, which asks you to confirm. Or add it by hand:

Add to .vscode/mcp.json

{
  "servers": {
    "staledocs": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "staledocs"
      ]
    }
  }
}

Add to ~/.codeium/windsurf/mcp_config.json

{
  "mcpServers": {
    "staledocs": {
      "command": "npx",
      "args": [
        "-y",
        "staledocs"
      ]
    }
  }
}

Add to your client's MCP settings (most use this shape)

{
  "mcpServers": {
    "staledocs": {
      "command": "npx",
      "args": [
        "-y",
        "staledocs"
      ]
    }
  }
}

Tools this server provides (1)

Taken from the project documentation; the running server may differ.

prepare_documentation_update
Give the assistant the exact doc sections and before and after signatures to update.

What it does

Public API diffing
Parses signatures with an AST and compares base and head.
Stale section mapping
Points to Markdown sections that mention changed symbols.
Repository audit
Finds scripts, paths and members docs mention that no longer exist.
Report-only Action
Posts a comment and labels without failing the build.
Validated fixes
Checks an assistant's drafted documentation update before it is written.
No model needed
Deterministic analysis with no API key.

Good for

  • Catch README drift in a pull request
  • Audit a repo's docs and agent instruction files
  • Have an assistant update only the affected doc sections
  • Label breaking changes automatically

Pricing

Open source

Open source, free; public beta

Prices change. Check staledocs.com before you buy.

StaleDocs FAQ

Does it need an API key?

No. The analysis is deterministic AST checking.

Which languages work?

TypeScript, JavaScript and Python.

Will it edit my repository?

Not on its own; the assistant applies approved Markdown.

How accurate is it?

The site reports 7 of 10 agreements with hand-labelled expectations on ten external pull requests, and publishes the misses.

Is StaleDocs free?

Yes. StaleDocs is open source, so you can use and self-host it for free.

How do I add StaleDocs to Claude Code?

Run this command in your terminal: claude mcp add staledocs -- npx -y staledocs

What are the best alternatives to StaleDocs?

The closest alternatives to StaleDocs are REA, Codebase Memory, GitHub, Serena MCP: the IDE for your agent and XERJ.

Alternatives to StaleDocs

  1. REA

    MCP server

    CLI and MCP server that lets coding agents reverse engineer apps and binaries

    Runs locally
    • Open source
    • 464K GitHub stars
    • Developer tools
  2. Codebase Memory

    MCP server

    Local MCP server that builds a code knowledge graph for AI coding agents

    Runs locally
    • Open source
    • 48.7K GitHub stars
    • Knowledge and memory
  3. GitHub

    MCP server

    Official MCP server connecting AI assistants to GitHub repos, issues and workflows

    Not checked yet
    • Remote
    • Open source
    • 34.5K GitHub stars
    • Developer tools
  4. MCP toolkit giving coding agents symbol-level code retrieval and editing

    Runs locally
    • Open source
    • 31.5K GitHub stars
    • Developer tools
  5. XERJ

    MCP server

    Local search engine for AI agents with cited answers over your code and docs

    Runs locally
    • Open source
    • 19.2K GitHub stars
    • Knowledge and memory
  6. Ouroboros

    MCP server

    Spec-first layer that pins requirements and verifies results of AI coding agent work

    Runs locally
    • Open source
    • 6.4K GitHub stars
    • Developer tools