your-docs-mcp

An MCP server that gives AI assistants structured access to your documentation. Supports markdown with YAML frontmatter, OpenAPI specs, full-text search, a web interface, and PDF generation.

Installation

Install from PyPI:

pip install your-docs-mcp

With semantic search (recommended):

pip install "your-docs-mcp[vector]" --extra-index-url https://download.pytorch.org/whl/cpu

With PDF generation:

pip install "your-docs-mcp[pdf]"

All features:

pip install "your-docs-mcp[vector,pdf]" --extra-index-url https://download.pytorch.org/whl/cpu

PDF generation requires system packages:

• macOS: brew install pandoc basictex
• Ubuntu/Debian: sudo apt install pandoc texlive-xetex texlive-latex-extra

Quick Start

export DOCS_ROOT=/path/to/your/docs
your-docs-server

Open http://localhost:8123 to browse your docs. The MCP server is also running for AI clients.

AI Client Setup

Claude Desktop - edit ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "docs": {
      "command": "your-docs-mcp",
      "env": {
        "DOCS_ROOT": "/absolute/path/to/your/docs"
      }
    }
  }
}

VS Code - create .vscode/mcp.json:

{
  "servers": {
    "docs": {
      "command": "your-docs-mcp",
      "env": {
        "DOCS_ROOT": "${workspaceFolder}/docs"
      }
    }
  }
}

Available MCP Tools

Supported Formats

Markdown with YAML frontmatter:

---
title: Getting Started
tags: [guide, quickstart]
order: 1
---

# Getting Started

Your content here...

OpenAPI 3.x (.yaml or .json) is also supported.

Configuration

Key environment variables:

DOCS_ROOT=/path/to/docs          # Required: documentation root directory
MCP_DOCS_CACHE_TTL=3600          # Cache TTL in seconds
MCP_DOCS_SEARCH_LIMIT=10         # Max search results
MCP_DOCS_WEB_PORT=8123           # Web server port
LOG_LEVEL=INFO                   # DEBUG, INFO, WARNING, ERROR

Running Modes

your-docs-server   # MCP server + web interface
your-docs-mcp      # MCP server only
your-docs-web      # Web interface only

Development

git clone https://github.com/esola-thomas/your-docs-mcp
cd your-docs-mcp
pip install -e ".[dev,vector,pdf]" --extra-index-url https://download.pytorch.org/whl/cpu
pytest
ruff check .

Contributing

See the contributing guide for details on running tests, code style, and submitting pull requests. Open an issue to report bugs or request features.

License

MIT - see LICENSE for details.

Links

• PyPI
• Issue tracker
• Documentation
• MCP specification