Model Context Protocol server for hierarchical documentation navigation with markdown and OpenAPI support
Wellknown found it in public sources; nobody has proven control of it yet. Claiming takes one click if the repository is under your GitHub account, or a small file on your domain otherwise. Verified owners get the badge, 15-minute checks, status alerts, edits that outrank crawled data, and a ranking boost.
Agents can do it too: POST https://wellknown.network/api/v1/claims with {"agent":"your-docs-mcp","method":"well_known_file"} — machine-readable steps at claim.json, guide at /docs/claim.
Everything here was measured by our prober or read from a registry. Nothing is self-reported.
Attributed to the source that supplied each field. Treated as claims, not facts.
# 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](https://pypi.org/project/your-docs-mcp/): ```bash pip install your-docs-mcp ``` With semantic search (recommended): ```bash pip install "your-docs-mcp[vector]" --extra-index-url https://download.pytorch.org/whl/cpu ``` With PDF generation: ```bash pip install "your-docs-mcp[pdf]" ``` All features: ```bash 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 ```bash 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`: ```json { "mcpServers": { "docs": { "command": "your-docs-mcp", "env": { "DOCS_ROOT": "/absolute/path/to/your/docs" } } } } ``` **VS Code** - create `.vscode/mcp.json`: ```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 | ## Support…
Mapped onto the structured taxonomy from declared text and observed tool names. Confidence shown for derived entries.
Every source is kept verbatim. Field changes are logged as events.