Qt 4.8.4 Documentation MCP Server

Bring Qt 4.8.4 documentation to your AI coding assistant. Works offline with local docs.

Tool Reference | Changelog | Contributing | Troubleshooting

✨ Features

• 🔌 Offline-First - Works entirely with local documentation
• 🔍 Full-Text Search - Find what you need across all Qt docs
• ⚡ Smart Caching - Fast responses for repeated queries
• 🎯 Fragment Support - Extract specific sections when needed
• 🛠️ MCP Standard - Compatible with Claude, VS Code, and other MCP clients

📦 Prerequisites

• Python 3.11+ required
• Qt 4.8.4 HTML Documentation
  • Download automatically via included script, or
  • Manual download from qt.io archives
• ~500MB disk space for docs + cache + search index
• SQLite with FTS5 support (included in Python 3.11+ by default)

🚀 Installation

From PyPI (Recommended)

pip install qt4-doc-mcp-server

From Source

git clone https://github.com/jztan/qt4-doc-mcp-server.git
cd qt4-doc-mcp-server
pip install -e .[dev]

Setup Qt Documentation

# Automated setup (recommended)
python scripts/prepare_qt48_docs.py --segments 4

# This will:
# - Download Qt 4.8.4 source archive
# - Extract HTML documentation
# - Create .env with sensible defaults
# - Copy GFDL license file

Quick Start Commands

# 1. Install
pip install qt4-doc-mcp-server

# 2. Setup Qt docs
python scripts/prepare_qt48_docs.py --segments 4

# 3. Build search index
qt4-doc-build-index

# 4. Start server
qt4-doc-mcp-server

# 5. Verify health
curl -s http://127.0.0.1:8000/health

⚙️ Configuration

Create a .env file in the repo root. The helper script writes sensible defaults; adjust as needed:

🔌 MCP Client Setup

The server exposes an HTTP endpoint at http://127.0.0.1:8000/mcp. Register it with your preferred MCP-compatible agent using the instructions below.

code --add-mcp '{"name":"qt4-docs","type":"http","url":"http://127.0.0.1:8000/mcp"}'

{
  "servers": {
    "qt4-docs": {
      "type": "http",
      "url": "http://127.0.0.1:8000/mcp"
    }
  }
}

claude mcp add --transport http qt4-docs http://127.0.0.1:8000/mcp

{
  "mcpServers": {
    "qt4-docs": {
      "type": "http",
      "url": "http://127.0.0.1:8000/mcp"
    }
  }
}

codex mcp add qt4-docs -- npx -y mcp-client-http http://127.0.0.1:8000/mcp

[mcp_servers.qt4-docs]
command = "npx"
args = ["-y", "mcp-client-http", "http://127.0.0.1:8000/mcp"]

{
  "mcpServers": {
    "qt4-docs": {
      "type": "http",
      "url": "http://127.0.0.1:8000/mcp"
    }
  }
}

{
  "mcpServers": {
    "qt4-docs": {
      "command": "npx",
      "args": ["-y", "mcp-client-http", "http://127.0.0.1:8000/mcp"]
    }
  }
}

🛠️ Available Tools

The server provides 2 MCP tools for working with Qt 4.8.4 documentation:

1. read_documentation - Read and convert specific Qt documentation pages to Markdown

   • Fragment extraction (#details, #public-functions)
   • Pagination with start_index and max_length
   • Section-only mode for targeted content
   • Returns Markdown with normalized links and GFDL attribution

2. search_documentation - Full-text search across all Qt 4.8.4 documentation

   • SQLite FTS5 with BM25 relevance ranking
   • Context snippets with highlighted matches
   • Configurable result limits (default: 10, max: 50)

For detailed API documentation including parameters, return values, examples, and error handling, see the Tool Reference.

📚 Related Resources

• Model Context Protocol Specification
• Qt 4.8.4 Documentation Archive
• FastMCP Framework
• Tool Reference
• Changelog
• Contributing Guide
• Troubleshooting Guide

📄 License

• Code: MIT License (see LICENSE).
• Qt Documentation: © The Qt Company Ltd./Digia, licensed under GFDL 1.3. This server converts locally obtained docs and includes attribution in outputs. If you redistribute a local mirror, include LICENSE.FDL and preserve notices.
• See THIRD_PARTY_NOTICES.md for more details.