mcp-auto-documentor

An MCP server to create, manage, and search project documentation — with staleness tracking and optional semantic search.

Connect it to Cursor, Claude Desktop, or any MCP-compatible agent to let your AI document, browse and verify your codebase docs without leaving the chat.

Features

• Create & update docs — write markdown documentation entries linked to source files
• Staleness tracking — automatically detects when tracked files have changed since the last doc update
• Semantic search — find relevant docs by meaning (requires an OpenAI API key)
• Multi-project support — organize docs into separate projects and switch between them
• GUI — built-in web interface to browse and read documentation
• Proxy-aware — integrates with the proxy-setup for GUI exposure

Installation

npx mcp-auto-documentor

Or install globally:

npm install -g mcp-auto-documentor

MCP Configuration

Add to your MCP client config (e.g. Cursor mcp.json):

{
  "mcpServers": {
    "mcp-auto-documentor": {
      "command": "npx",
      "args": ["-y", "mcp-auto-documentor"],
      "env": {
        "OPENAI_API_KEY": "sk-..."
      }
    }
  }
}

Environment Variables

| Variable | Required | Description | |---|---|---| | OPENAI_API_KEY | No | Enables semantic search via OpenAI embeddings | | PROXY_URL | No | URL of the proxy server to register the GUI |

Available Tools

| Tool | Description | |---|---| | create_doc | Create a new documentation entry linked to source files | | get_doc | Retrieve a documentation entry with full content | | get_doc_metadata | Get metadata and freshness status without loading content | | list_docs | List all docs in the current project with staleness indicators | | update_doc | Update an existing documentation entry | | search_docs | Search docs by keyword or semantic similarity | | check_freshness | Check if a doc is up-to-date relative to its tracked files | | refresh_file_snapshot | Mark files as up-to-date without editing the doc content | | list_projects | List all documentation projects | | set_project | Switch to a different project |

Data Storage

Documentation is stored locally in a data/ directory next to the server process. This directory is not included in the npm package — it is created at runtime in the working directory.

License

ISC