io.qt.qt-docs-mcp/qt-documentation

Official2 tools

Qt Documentation

Search Qt 6 API and product docs (Qt Core, Qt Quick, Qt Creator, Boot to Qt, MCUs).

Searchable Qt 6 API and product documentation for development frameworks and tools.

Captured live from the server via tools/list.

qt_documentation_search

Call qt_documentation_search when: (a) you're about to claim a signal/slot/property/default exists, (b) the API is in Qt 6.7+ or a non-core module (MQTT, OPC UA, Network Auth, etc), (c) the user used the words 'docs', 'official', 'verify', or 'check'. Skip when: the question is about basic QString/QObject/signal-slot syntax.

Parameters (8)

filterstring
Optional: Filter by document type. Default is 'all'. Note: 'function' returns the class reference page that contains the function (there are no function-level pages); for QML, use 'qml'.
intentstring
Optional: Prioritizes (not filters) results by type. 'api'=class reference, 'tutorial'=how-to guides, 'guide'=overviews, 'concept'=explanations, 'example'=code samples, 'migration'=porting guides.
keywordsarray
Optional: Array of keywords to search for. Results match ANY keyword. Example: ["button", "signal", "connect"]. Alternative to 'query' for better multi-term matching.
max_resultsinteger
Optional: Maximum number of results to return (1-10). Default is 3.
modulestring
Optional: Limit search to specific Qt module (e.g., 'qtcore', 'qtwidgets', 'qtqml', 'qtquick', 'qtnetwork')
productstring
Optional: Limit search to a specific documentation product (e.g. 'qt', 'qtcreator', 'pyside6'). Omit to search all products.
querystring
Search query for Qt documentation (e.g., 'Animation', 'QTimer', 'signal slot'). Optional if 'keywords' is provided.
versionstring
Optional: Qt version to search (e.g., '6.10.0', '6.9.0'). Defaults to latest installed version if not specified.

qt_documentation_read

Read the full content of a specific Qt documentation page. Use the filename shown in search results.

Parameters (2)

filestringrequired
Filename of the Qt documentation page. Use ONLY the filename from search results (e.g., 'signalsandslots.html' NOT full paths with version numbers). Module paths like 'qtcore/qobject.html' also work.
versionstring
Optional: Qt version to read from (e.g., '6.10.0', '6.9.0'). Defaults to latest installed version if not specified.

Install

claude_desktop_config.json

{
  "mcpServers": {
    "qt-documentation": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://qt-docs-mcp.qt.io/mcp"
      ]
    }
  }
}

Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.