docs-mcp-server

Multi-tenant Model Context Protocol (MCP) server for documentation search and retrieval.

Use one server to index docs from websites, git repositories, and local markdown folders, then expose them to AI clients through a clean MCP toolset.

Why this project exists

LLM answers are only as good as their context. docs-mcp-server makes your assistant query your real docs instead of relying on stale model memory.

• Run a single MCP endpoint for many documentation tenants.
• Keep sources fresh with scheduler-driven sync.
• Return ranked snippets and full documents with source URLs.

Who this is for

• Teams using MCP-compatible clients (Copilot, Claude, custom tools).
• Platform/dev experience teams curating internal + external docs.
• Engineers who want deterministic, inspectable doc retrieval.

Quick start (10–15 minutes)

git clone https://github.com/pankaj28843/docs-mcp-server.git
cd docs-mcp-server
uv sync
cp deployment.example.json deployment.json
uv run python deploy_multi_tenant.py --mode online
uv run python trigger_all_syncs.py --tenants drf --force
uv run python debug_multi_tenant.py --host localhost --port 42042 --tenant drf --test search

If search returns ranked results with URLs/snippets, your tenant is live.

Add to ~/.config/Code/User/mcp.json:

{
  "servers": {
    "TechDocs": {
      "type": "http",
      "url": "http://127.0.0.1:42042/mcp"
    }
  }
}

Documentation map

• Start here: docs/index.md
• First-time walkthrough: docs/tutorials/getting-started.md
• Operational recipes: docs/how-to/
• API and config lookup: docs/reference/
• Architecture and trade-offs: docs/explanations/

Docs follow Divio quadrants: tutorials, how-to guides, reference, and explanations.

Runtime and architecture deep dives

• Runtime modes (online vs offline): docs/explanations/runtime-modes-and-starlette.md
• Mode evaluation checklist: docs/how-to/evaluate-runtime-modes.md
• Entrypoint and startup flow: docs/reference/entrypoint-walkthrough.md
• Core library rationale and mapping: docs/reference/core-library-map.md

Core tools exposed via MCP

• list_tenants
• find_tenant
• describe_tenant
• root_search
• root_fetch

See full contracts in docs/reference/mcp-tools.md.

Source code orientation

• Process entrypoint: src/docs_mcp_server/app.py
• App composition: src/docs_mcp_server/app_builder.py
• Root MCP tool hub: src/docs_mcp_server/root_hub.py
• Tenant composition: src/docs_mcp_server/tenant.py

Deep-dive guides that match these files:

• docs/reference/entrypoint-walkthrough.md
• docs/explanations/runtime-modes-and-starlette.md
• docs/reference/mcp-tools.md
• docs/reference/core-library-map.md

Contributing and quality gates

Development + CI validation loop:

uv run ruff format . && uv run ruff check --fix .
timeout 120 uv run pytest -m unit --cov=src/docs_mcp_server --cov-fail-under=95
timeout 120 uv run python integration_tests/ci_mcp_test.py
uv run mkdocs build --strict

More in docs/contributing.md.

License

MIT — see LICENSE.