papermoon-mkdocs-mcp

# papermoon-mkdocs-mcp A lightweight MCP server for MkDocs documentation sites. Reads markdown files directly from disk, provides full-text and optional semantic search, and exposes project structure through the Model Context Protocol. ## Features - **5 MCP tools** -- search, read_document, list_documents, get_project_info, get_document_outline - **SQLite FTS5 keyword search** with BM25 ranking (zero external dependencies) - **Optional semantic vector search** via sentence-transformers - **Hybrid search** combining keyword + vector results with Reciprocal Rank Fusion - **Incremental indexing** -- fast updates when files change - **Persistent SQLite index** that survives server restarts - **Navigation-aware** -- parses `mkdocs.yml` and `.nav.yml` - **Excludable documents** -- keep drafts and internal pages off the MCP surface - **Security-first** -- path traversal prevention, read-only search connections - **Minimal dependencies** -- 3 required, 2 optional ## Installation ```bash pip install papermoon-mkdocs-mcp ``` To enable vector search: ```bash pip install papermoon-mkdocs-mcp[vector] ``` ## Quick Start Run from the root of any MkDocs project (where `mkdocs.yml` lives): ```bash cd /path/to/your/mkdocs-project papermoon-mkdocs-mcp ``` Or point to a specific config file: ```bash papermoon-mkdocs-mcp --config /path/to/mkdocs.yml ``` The server auto-detects `mkdocs.yml` in the current directory when `--config` is omitted. ### Transport Options By default the server uses **stdio** transport. You can switch to a network transport for remote or multi-client setups: ```bash # Streamable HTTP (recommended for network access) papermoon-mkdocs-mcp --transport streamable-http --host 0.0.0.0 --port 9000 # SSE (legacy client compatibility) papermoon-mkdocs-mcp --transport sse --port 8080 ``` | Flag | Default | Description | |-----------------|---------------|-----------------------------------------------…