Skip to content

Tutorial: Adding Your First Tenant

Time: ~10 minutes
Prerequisites: Completed Getting Started tutorial, server running
What you'll learn: Add a custom documentation source to your deployment

Why This Matters

The example configuration covers popular frameworks, but you likely have project-specific docs, internal wikis, or niche libraries. Adding custom tenants lets your AI assistant search exactly the documentation you need—not just public frameworks.

Overview

The example deployment.json includes 10 pre-configured tenants. This tutorial shows you how to add your own documentation source.

Step 1: Choose Your Documentation Source

Decide what type of documentation you want to add:

Type Use Case Example
Online Website with sitemap or crawlable pages FastAPI docs, Django docs
Git Markdown files in a GitHub/GitLab repo MkDocs project, README collection
Filesystem Local markdown files Your own project docs

Step 2: Edit deployment.json

Open deployment.json and add a new tenant to the "tenants" array.

Example: Online Tenant (Website)

{
  "source_type": "online",
  "codename": "httpx",
  "docs_name": "HTTPX Docs",
  "docs_sitemap_url": "https://www.python-httpx.org/sitemap.xml",
  "url_whitelist_prefixes": "https://www.python-httpx.org/",
  "enable_crawler": false,
  "docs_root_dir": "./mcp-data/httpx",
  "refresh_schedule": "0 2 */14 * *",
  "test_queries": {
    "natural": ["How to make async HTTP requests"],
    "phrases": ["async", "client"],
    "words": ["httpx", "request", "response"]
  }
}

Example: Git Tenant (GitHub Repo)

{
  "source_type": "git",
  "codename": "my-project",
  "docs_name": "My Project Docs",
  "git_repo_url": "https://github.com/username/my-project.git",
  "git_branch": "main",
  "git_subpaths": ["docs"],
  "git_strip_prefix": "docs",
  "docs_root_dir": "./mcp-data/my-project",
  "refresh_schedule": "0 */6 * * *",
  "test_queries": {
    "natural": ["Getting started with my project"],
    "phrases": ["installation"],
    "words": ["setup", "config"]
  }
}

Step 3: Redeploy

After editing deployment.json, redeploy the container:

uv run python deploy_multi_tenant.py --mode online

Step 4: Trigger Sync

Sync your new tenant:

uv run python trigger_all_syncs.py --tenants httpx --force

Wait 1-2 minutes for the sync to complete. Check progress in container logs:

docker logs docs-mcp-server 2>&1 | grep -i httpx | tail -10

Verify your tenant returns results:

uv run python debug_multi_tenant.py --host localhost --port 42042 --tenant httpx --test search

You should see output like:

Testing search for tenant: httpx
Query: "async client"
Found 5 results (top score: 8.34)
✓ Search working

Verification

Success Indicators

  • Container logs show "Indexed N documents for httpx"
  • Search returns 3+ results with positive scores
  • No errors in docker logs docs-mcp-server | tail -20

Common Issues

Symptom Cause Fix
"Tenant not found" Codename typo Check codename matches exactly in JSON
0 search results Sync not complete Wait longer, check logs for progress
403/404 errors URL blocked Check url_whitelist_prefixes matches sitemap URLs

Next Steps