Skip to main content
Glama
Documentation MCP Server

Documentation MCP Server

by esola-thomas

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

Related MCP server: Dedalus MCP Documentation Server

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

Tool

Description

search_documentation

Full-text search with relevance scoring

navigate_to

Navigate to a doc by URI (e.g. docs://guides/quickstart)

get_table_of_contents

Get the full documentation hierarchy

get_document

Retrieve a document and its metadata

search_by_tags

Filter docs by tags

get_all_tags

List all tags across documentation

generate_pdf_release

Generate a PDF of all documentation

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.

Available Tools

6 tools
get_all_tagsA

Get a list of all unique tags defined across the documentation. Optionally filter by category and include document counts per tag.

Inputs: category, include_counts.

get_documentA

Get full content and metadata for a specific document by URI.

Inputs: uri (required).

get_table_of_contentsB

Get the complete documentation hierarchy as a table of contents tree.

Inputs: max_depth.

search_by_tagsC

Search documentation by metadata tags and category.

Inputs: tags (required), category, limit.

search_documentationA

Search documentation with full-text search. Returns results with hierarchical context (breadcrumbs).

Inputs: query (required), category, limit.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.5/5.0

    Scored across 6 tools

    Disambiguation4/5

    Most tools are clearly distinct: search_documentation is full-text, search_by_tags is metadata-based, get_document retrieves content, and navigation tools handle hierarchy. There is slight overlap between search_documentation and search_by_tags, but the descriptions clarify the different search modes.

    Naming Consistency4/5

    Tool names consistently use verb_noun pattern (search_documentation, navigate_to, get_table_of_contents, get_document, get_all_tags). search_by_tags follows the pattern, though 'navigate_to' is slightly less descriptive than the others but still consistent in style.

    Tool Count5/5

    Six tools is well-scoped for a documentation server, covering search, navigation, and metadata retrieval without unnecessary redundancy. Each tool serves a distinct purpose in the documentation workflow.

    Completeness4/5

    The surface covers core documentation needs: full-text search, tag search, navigation, TOC, and document retrieval. Minor gaps include no obvious way to get related documents or search within a specific subtree, but the core workflows are complete.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      A
      quality
      D
      maintenance
      Enables AI-powered querying and management of documentation through markdown file serving, keyword search, and OpenAI-based Q\&A capabilities. Supports document indexing, analysis, and agent handoffs with rate limiting protection.
      5
      MIT
    • A
      license
      Not graded
      quality
      Not graded
      maintenance
      Enables AI-powered querying and serving of markdown documentation with search, Q\&A capabilities, and document analysis. Built for the YC Agents Hackathon with OpenAI integration and rate limiting protection.
      MIT