docs-mcp-server documentation

Welcome. This documentation is organized for users, operators, and contributors.

If this is your first time here, start with the tutorial and do not skip verification steps.

Start here

• New to the project: Tutorial: Get running in 15 minutes
• Adding or editing tenants: How-to guides
• Looking up schemas and commands: Reference
• Understanding architecture choices: Explanations

What this server does

docs-mcp-server is a multi-tenant MCP server that:

• indexes documentation sources,
• ranks search results with BM25,
• serves tool responses over MCP,
• and keeps tenants fresh with schedulers.

Why this structure

This project follows a Divio-style documentation model (tutorials, how-to, reference, explanations), similar to popular open-source documentation systems.

You should be able to answer four different questions quickly:

1. How do I get started? → Tutorials
2. How do I solve task X? → How-to guides
3. What are the exact options/contracts? → Reference
4. Why is it designed this way? → Explanations

Documentation map

Tutorials (learning)

• Getting started
• Adding your first tenant
• Custom search configuration

How-to guides (task-focused)

• Configure online tenant
• Configure git tenant
• Deploy with Docker
• Evaluate runtime modes
• Trigger syncs
• Tune search ranking
• Debug crawlers
• Preview docs locally

Reference (lookup)

• deployment.json schema
• CLI commands
• MCP tools API
• Entrypoint walkthrough
• Core library map
• Environment variables
• Python API

Explanations (why)

• Architecture
• Runtime modes and Starlette integration
• Search ranking (BM25)
• Sync strategies
• Cosmic Python patterns
• Observability

Quick verification checklist

After setup, verify the core path end-to-end:

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

Success means your search returns ranked results with URLs and snippets.

Need to contribute?

See Contributing for development workflow, validation gates, and documentation standards.