DevDocs MCP Server

Local, version-aware, and authoritative documentation for AI agents.

README.md

DevDocs-MCP: Documentation Authority for AI Agents

Eliminate AI hallucinations with local, version-aware, and authoritative documentation.

DevDocs-MCP is a Model Context Protocol (MCP) server that provides version-pinned, deterministic documentation sourced from DevDocs.io to AI assistants (Claude, RooCode, Cline, Copilot etc.). It acts as a local Documentation Intelligence Layer, ensuring your agent always has the correct API context without network latency or training data drift.

This server follows the proposed MCP server standard defined by the MCP , which is being adopted by AI tools and agents across the ecosystem, including those from providers such as Anthropic, OpenAI, and Google.


⚠️ Project Status Notice ⚠️ This project is under active and heavy development. Still need to test existing features and implement more new features like optimal caching , update latest doc automatically and also on request basis , optimal querying and more... Design decisions, APIs, and structure are expected to evolve based on strong opinions, reviews, and feedback from the developer community. I warmly welcome discussions, critiques, and contributions to help shape this project in the right direction.


📑 Table of Contents

  1. Overview
  2. Key Capabilities
  3. Quickstart
  4. Installation & Setup
  5. AI Agent Configuration
  6. Further Reading

🎯 Overview

What This Project Is
  • A local MCP server written in NestJS (TypeScript).
  • A deterministic authority for documentation metadata and content.
  • A lazy-ingestion engine that caches DevDocs offline.
  • A project-aware context manager that pins docs to your package.json versions.
What This Project Is NOT
  • ❌ An AI agent or code generator.
  • ❌ A web scraper (it uses structured DevDocs datasets).
  • ❌ A DevDocs UI replacement.
  • ❌ A hosted SaaS (it runs 100% locally).
Why This Exists (The Problem)

Modern AI coding agents face three major hurdles:

  1. Hallucination: Guessing API signatures or using deprecated methods.
  2. Latency: Fetching live web docs for every query is slow.
  3. Version Drift: Mixing up React 18 with React 19 features.

The Solution: DevDocs-MCP provides "Just-in-Time" documentation retrieved from local storage, filtered by your project's specific dependency versions.

Mental Model

DevDocs-MCP acts as a middleware between your IDE Agent and the documentation source.

graph TD
    Agent["AI Agents"] -->|MCP Search/Explain| Server["DevDocs-MCP Server"]
    Server -->|Metadata| DB[(SQLite - sql.js)]
    Server -->|Content| FS[Local Disk - JSON Cache]
    Server -.->|Lazy Fetch| Web[DevDocs.io API]

🚀 Key Capabilities

  • Offline-First: Documentation is cached locally; no internet is needed after ingestion.
  • Ranked Fuzzy Search: Instantly find relevant entries (e.g., "intersection observer").
  • Version Awareness: Automatically maps to specific library versions in your project.
  • Node-Only Architecture: Uses sql.js for zero-native dependencies (no Python/C++ build steps).
  • Structured Outputs: Returns clean, LLM-optimized content.

⚡ Quickstart

  1. Clone & Install
git clone https://github.com/madhan-g-p/DevDocs-MCP.git
cd DevDocs-MCP
pnpm install
  1. Configure Environment
cp .env.example .env
# Edit .env: Set DEVDOCS_DATA_PATH to where you want to store docs.
  1. Build & Run
pnpm build
pnpm start:prod

Note: Strictly use pnpm for development and contributions.


🛠️ Installation & Setup

DevDocs-MCP is optimized for zero-fuss setup with pnpm. It is a Node-only project.

Prerequisites

  • Node.js 18+ (tested on 18.x and 20.x).

🐳 Docker Usage

DevDocs-MCP is designed to be lightweight and persistent. Since it downloads and caches large documentation datasets, managing your data volumes correctly is essential.

Method A: Docker Compose (Dynamic & Persistent)

This is the recommended way. It supports 3 storage modes via the DEVDOCS_VOLUME_SOURCE variable in your `.en

Tools 2

search_docsPerform a ranked fuzzy search across cached documentation entries.
get_doc_contentRetrieve the full content of a specific documentation entry.

Environment Variables

DEVDOCS_DATA_PATHrequiredPath to the directory where documentation datasets are stored.

Try it

Search for the documentation on the Intersection Observer API.
Find the latest syntax for React useEffect hook.
Get the full documentation content for the Node.js fs.readFile method.
Explain how to use the Python requests library based on the local documentation.

Frequently Asked Questions

What are the key features of DevDocs MCP?

Offline-first documentation access via local caching. Ranked fuzzy search for documentation entries. Version-aware mapping to project-specific library versions. Node-only architecture with zero-native dependencies. Structured, LLM-optimized content delivery.

What can I use DevDocs MCP for?

Eliminating AI hallucinations regarding API signatures and deprecated methods. Reducing latency by avoiding live web lookups for documentation. Ensuring consistent API context for projects with specific dependency versions. Working in air-gapped or offline development environments.

How do I install DevDocs MCP?

Install DevDocs MCP by running: git clone https://github.com/madhan-g-p/DevDocs-MCP.git && cd DevDocs-MCP && pnpm install && pnpm build

What MCP clients work with DevDocs MCP?

DevDocs MCP works with any MCP-compatible client including Claude Desktop, Claude Code, Cursor, and other editors with MCP support.

Turn this server into reusable context

Keep DevDocs MCP docs, env vars, and workflow notes in Conare so your agent carries them across sessions.

Open Conare