Qt4 Doc MCP Server

Name: Qt4 Doc MCP Server
Author: jztan

by jztanversion 0.7.0i★ –iRuns on your computer

Registry nameio.github.jztan/qt4-doc-mcp-server

Install

Overview

Description from the maker (original English)

Offline MCP server for local Qt 4.8, Qt 5, and Qt 6 documentation with full-text search.

PopNx MCP’s three pillars

These three are never merged into one score: opinions, measurements and popularity are different things.

User voiceiNo reviews yetReviews open together with accounts in a later step
Our basic checksi1 of 1 passedChecked from public information; code not scanned yet
UsageiVery new↓ 22/wk · ★ –

What you can do with it

We have not written a plain-language summary for this one yet. Below are the facts we read from the registry.

Connection: Runs on your computer
Transport: Streamable HTTP
Category: Search & AI memory
You need to fill in: QT_DOC_BASE

Install

Pick the AI app you use, then copy the settings.

Before you install

Basic checks: 1 of 1 passed
Runs on your computer with your user’s permissions (files, network, apps).
You fill in yourself: QT_DOC_BASE, QT_DOC_STATE_DIR, SERVER_HOST, SERVER_PORT

You need

PyPIPython’s uv installed (for the uvx command)

Which app do you use?

ClaudeClaude CodeCursorVS CodeChatGPT

Pick your app above. We remember it, so next time the button says “Install in …”.

Open Claude Desktop → Settings → Developer → Edit Config, and paste this into claude_desktop_config.json

{
  "mcpServers": {
    "qt4-doc": {
      "command": "uvx",
      "args": [
        "qt4-doc-mcp-server"
      ],
      "env": {
        "QT_DOC_BASE": "your-value",
        "QT_DOC_STATE_DIR": "your-value",
        "SERVER_HOST": "your-value",
        "SERVER_PORT": "your-value"
      }
    }
  }
}

Run this in your terminal

claude mcp add qt4-doc --env QT_DOC_BASE=your-value --env QT_DOC_STATE_DIR=your-value --env SERVER_HOST=your-value --env SERVER_PORT=your-value -- uvx qt4-doc-mcp-server

Fill in the empty values before running it.

Open in Cursor

Or copy the settings yourself

Paste into .cursor/mcp.json in your project, or ~/.cursor/mcp.json

{
  "mcpServers": {
    "qt4-doc": {
      "command": "uvx",
      "args": [
        "qt4-doc-mcp-server"
      ],
      "env": {
        "QT_DOC_BASE": "your-value",
        "QT_DOC_STATE_DIR": "your-value",
        "SERVER_HOST": "your-value",
        "SERVER_PORT": "your-value"
      }
    }
  }
}

Your browser asks to open the app, then the app shows the settings and asks you to confirm. Key values are left empty for you to fill in.

Open in VS Code

Or copy the settings yourself

Paste into .vscode/mcp.json in your project

{
  "servers": {
    "qt4-doc": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "qt4-doc-mcp-server"
      ],
      "env": {
        "QT_DOC_BASE": "your-value",
        "QT_DOC_STATE_DIR": "your-value",
        "SERVER_HOST": "your-value",
        "SERVER_PORT": "your-value"
      }
    }
  }
}

Your browser asks to open the app, then the app shows the settings and asks you to confirm. Key values are left empty for you to fill in.

This one runs on your computer, and ChatGPT can only connect to servers on the internet. Pick another app.

Your choice stays on this device in a cookie; no account needed.

Values you fill in

QT_DOC_BASE required env
Absolute path to a local Qt 4.8, Qt 5, or Qt 6 HTML documentation root (required)
QT_DOC_STATE_DIR env
Writable directory for the search index and Markdown cache (default: $QT_DOC_BASE/.index; set when the documentation root is read-only)
SERVER_HOST env
Server bind address (default: 127.0.0.1)
SERVER_PORT env
Server port (default: 8000)

These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.

What it can do

Runs on your computer; the tool list appears in your AI app after you install it.

Basic checksi

We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 9, 2026

✓ Pass
Maker matches the repo
The registry name was verified with the GitHub account jztan, which owns the repo
… Not checked yet
Still maintained
We have not read this repo from GitHub yet
… Not checked yet
Has a licence
We have not read this repo from GitHub yet
– Not applicable
Endpoint responds
This one runs on your computer; there is no internet endpoint
– Not applicable
Sign-in with OAuth
Runs on your computer and uses local settings instead
… Not checked yet
No hidden instructions in tool descriptions
Runs on your computer; we can only read tool lists from internet endpoints

Compared with others in Search & AI memoryi

More stars than 0% of the other 5754 servers in this category
Published to the registry more recently than 24% of the other 5754 servers in this category
Basic checks equal to or better than 100% of the other 5754 servers in this category

Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.

Common questions

Is Qt4 Doc MCP Server safe?

It passed 1 of 1 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.

What keys or codes does it need?

You need to fill in: QT_DOC_BASE

Does it run on my computer or in the cloud?

It runs on your computer. Your AI app starts it when needed, and data does not pass through the maker’s servers (unless it calls an online service itself).

Is it still maintained?

The GitHub repo last changed –, and the latest version (0.7.0) reached the registry 4 months ago.

Which apps can use it?

Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. You also need Python (uv) on your computer.

What can I use instead?

In the same category: Context7, Codebase Memory, Exa

Alternatives

Servers in the same category from other makers, sorted by stars.

Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi

Context7

Feeds AI the latest docs for libraries and frameworks before it answers, so code it writes does not use outdated, removed functions.

by upstashWidely used↓ 972.7K/wk★ 64.2KUpdated 3 days ago

Computer or cloud

Install

Codebase Memory

Codebase knowledge graph for AI agents — 162 languages, sub-ms queries, 99% fewer tokens.

by DeusDataWidely used↓ 18K/wk★ 48.1KUpdated 23 days ago

Runs on your computer

Install

Exa

Connect AI agents to Exa for web search, content fetching, and multi-step research.

by exa-labsWidely used★ 5.2KUpdated 2 months ago

Runs in the cloud✓ exa.ai

Install

README from the maker

Open the README

Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.

Qt Documentation MCP Server

mcp-name: io.github.jztan/qt4-doc-mcp-server

Bring locally installed Qt 4.8, Qt 5, or Qt 6 documentation to your AI coding assistant. Works offline with one selected documentation set at a time.

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 (not needed when using the Docker image)
Qt HTML Documentation for one supported release (Qt 4.8, Qt 5, or Qt 6)
The included helper downloads Qt 4.8.4 only.
Point QT_DOC_BASE directly at an existing Qt 5/6 offline documentation root.
~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 uv sync --locked

Setup Qt Documentation

# Automated setup (recommended, requires the cloned repo)

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

The helper script ships with the repo, not the PyPI package. Installed from PyPI only? Download the docs manually instead:

curl -LO https://download.qt.io/archive/qt/4.8/4.8.4/qt-everywhere-opensource-src-4.8.4.tar.gz

tar -xzf qt-everywhere-opensource-src-4.8.4.tar.gz qt-everywhere-opensource-src-4.8.4/doc/html mv qt-everywhere-opensource-src-4.8.4/doc/html ./qt4-docs-html

Then create a .env with QT_DOC_BASE pointing at that directory (see Configuration below).

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 (optional; the server builds it on first start)

qt-doc-build-index

4. Start server

qt-doc-mcp

5. Verify health

curl -s http://127.0.0.1:8000/health

The legacy qt4-doc-mcp-server command remains available as an alias for existing client configurations.

Agent-friendly FTS CLI

After building the index, agents can search and receive materialized absolute Markdown paths:

qt-doc-cli "accessible applications" --limit 5

The command reads the same .env settings as the server. Before searching, it automatically builds a missing/outdated FTS index and fully warms an incomplete Markdown cache. It then prints each result's title, absolute .md path, and FTS snippet to stdout; preparation messages, errors, and warnings go to stderr. Use qt-doc-warm-md --force after changing documentation in place.

🐳 Docker

Prebuilt multi-arch images (amd64/arm64) are published to GitHub Container Registry on every release. The container is offline-only: you mount your prepared Qt doc/html directory read-only at /docs, and all derived state (Markdown cache and search index) lives in a volume at /data.

# Prepare Qt docs on the host first (one-time, writes to ./qt4-docs-html)

python scripts/prepare_qt48_docs.py --segments 4

Run from GHCR

docker run -d --name qt4-doc-mcp-server -p 8000:8000 \ -v "$PWD/qt4-docs-html:/docs:ro" \ -v qt4-doc-data:/data \ ghcr.io/jztan/qt4-doc-mcp-server:latest

Verify

curl -s http://127.0.0.1:8000/health

Using only the published image, without cloning this repo? Download the Qt 4.8.4 docs directly instead of running the prepare script:

curl -LO https://download.qt.io/archive/qt/4.8/4.8.4/qt-everywhere-opensource-src-4.8.4.tar.gz

tar -xzf qt-everywhere-opensource-src-4.8.4.tar.gz qt-everywhere-opensource-src-4.8.4/doc/html mv qt-everywhere-opensource-src-4.8.4/doc/html ./qt4-docs-html

Any existing Qt 5 or Qt 6 doc/html tree (from the Qt installer or distro documentation packages) works as the mount source too.

First start converts and indexes the documentation into the /data volume; subsequent starts reuse it. Depending on the docset size, the first start can take a minute or two before the health endpoint responds.

Docker Compose

With docs in the default ./qt4-docs-html location, no configuration is needed:

docker compose up -d

For docs elsewhere (including Qt 5 or Qt 6 doc/html trees, which the server also supports), point QT_DOC_HTML_PATH at them. If port 8000 is taken on the host, set HOST_PORT in the same file (with plain docker run, change the left side of -p instead):

cp .env.docker.example .env.docker   # set QT_DOC_HTML_PATH

docker compose --env-file .env.docker up -d

Or use the convenience script, which checks Docker is running, creates .env.docker on first run, builds and starts the service, and waits for the health endpoint:

./deploy.sh

Point your MCP client at http://127.0.0.1:8000/mcp (streamable HTTP). Qt documentation is licensed under GFDL 1.3; the container serves your local copy and never redistributes it.

⚙️ Configuration

These settings apply to native (pip or source) runs. In Docker they are already set inside the container (QT_DOC_BASE=/docs, QT_DOC_STATE_DIR=/data, SERVER_HOST=0.0.0.0); the QT_DOC_HTML_PATH variable in .env.docker is not a server setting, just the host path mounted at /docs.

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

Variable	Default	Purpose
`QT_DOC_BASE`	_required_	Absolute path to one Qt 4.8, Qt 5, or Qt 6 HTML documentation root. The server detects the active docset.
`QT_DOC_STATE_DIR`	`$QT_DOC_BASE/.index`	Optional writable directory for the FTS index and Markdown cache. Use this when the documentation root is read-only.
`PREINDEX_DOCS`	`true`	Build search index automatically at startup if not present.
`PRECONVERT_MD`	`false`	Warm the Markdown cache automatically at MCP startup.
`SERVER_HOST`	`127.0.0.1`	Bind address for the FastMCP server (`0.0.0.0` for containers).
`SERVER_PORT`	`8000`	TCP port for streamable HTTP transport.
`MCP_LOG_LEVEL`	`WARNING`	Logging verbosity (DEBUG/INFO/WARNING/ERROR).
`MD_CACHE_SIZE`	`512`	In-memory CachedDoc LRU capacity (counts pages).
`DEFAULT_MAX_MARKDOWN_LENGTH`	`20000`	Default maximum characters returned per request (prevents token limit issues).

The tools identify documents by their exact root-relative Markdown path, not an online URL. For example, use qcompleter.md for a Qt 4 page, qtdoc/accessible.md for a Qt 5/6 global page, or qtcore/qobject.md for a Qt 5/6 Core page. By default, each docset stores its own index and Markdown cache under $QT_DOC_BASE/.index/, so switching QT_DOC_BASE reuses its existing derived state. Set QT_DOC_STATE_DIR to relocate both to a writable directory. The Markdown cache mirrors the documentation tree: for example, qtcore/qobject.md is cached as .index/md/qtcore/qobject.md plus qobject.meta.json with the default state directory.

🔌 MCP Client Setup

By default, 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.

Stdio transport

Run the server over stdio instead of HTTP with:

qt-doc-mcp --transport stdio

For stdio-only MCP clients, configure that command with args: ["--transport", "stdio"]. Startup indexing and Markdown-cache progress are written to stderr, leaving stdout exclusively for MCP protocol messages.

Visual Studio Code (Native MCP Support)

VS Code has built-in MCP support via GitHub Copilot (requires VS Code 1.102+).

Using CLI (Quickest):

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

Using Command Palette:

Open Command Palette (Cmd/Ctrl+Shift+P)
Run MCP: Open User Configuration (for global) or MCP: Open Workspace Folder Configuration (for project-specific)
Add the configuration:

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

4. Save the file. VS Code will automatically load the MCP server.

Manual Configuration: Create .vscode/mcp.json in your workspace (or mcp.json in your user profile directory):

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

Claude Code

Add to Claude Code using the CLI command:

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

Or configure manually in your Claude Code settings file (~/.claude.json):

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

Codex CLI

Add to Codex CLI using the command:

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

Or configure manually in ~/.codex/config.toml:

[mcp_servers.qt-docs]

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

Note: Codex CLI primarily supports stdio-based MCP servers. The above uses mcp-client-http as a bridge for HTTP transport.

Kiro

Kiro primarily supports stdio-based MCP servers. For HTTP servers, use an HTTP-to-stdio bridge:

Create or edit .kiro/settings/mcp.json in your workspace:

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

2. Save the file and restart Kiro. The active Qt documentation tools will appear in the MCP panel.

Note: Direct HTTP transport support in Kiro is limited. The above configuration uses mcp-client-http as a bridge to connect to HTTP MCP servers.

Generic MCP Clients

Most MCP clients use a standard configuration format. For HTTP servers:

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

For clients that require a command-based approach with HTTP bridge:

"mcpServers": { "qt-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 the active local Qt documentation set:

**`read

Only the beginning is shown; read the rest in the repo

Qt4 Doc MCP Server

Overview

PopNx MCP’s three pillars

What you can do with it

Install

Before you install

Values you fill in

What it can do

Basic checksi

Maker matches the repo

Still maintained

Has a licence

Endpoint responds

Sign-in with OAuth

No hidden instructions in tool descriptions

Compared with others in Search & AI memoryi

Common questions

Alternatives

Context7

Codebase Memory

Exa

README from the maker

Qt Documentation MCP Server

Tool Reference | Changelog | Contributing | Troubleshooting

✨ Features

📦 Prerequisites

🚀 Installation

From PyPI (Recommended)

From Source

Setup Qt Documentation

This will:

- Download Qt 4.8.4 source archive

- Extract HTML documentation

- Create .env with sensible defaults

- Copy GFDL license file

Quick Start Commands

2. Setup Qt docs

3. Build search index (optional; the server builds it on first start)

4. Start server

5. Verify health

Agent-friendly FTS CLI

🐳 Docker

Run from GHCR

Verify

Docker Compose

⚙️ Configuration

🔌 MCP Client Setup

Stdio transport

🛠️ Available Tools