Skip to main content
Glama
Sign In

Qt Documentation

by io.qt.qt-docs-mcp
OverviewDiscussionsAdmin

qt_documentation_search

Read-only

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.

Input Schema

NameRequiredDescriptionDefault
queryNoSearch query for Qt documentation (e.g., 'Animation', 'QTimer', 'signal slot'). Optional if 'keywords' is provided.
filterNoOptional: Filter by document type. One of 'all', 'class', 'qml', 'function', 'guide'. Default is 'all'. Note: 'function' returns the class reference page that contains the function; pass the function name as 'symbol' to the read tool to get just that member. For QML, use 'qml'.
intentNoOptional: Prioritizes (not filters) results by type. One of 'api', 'tutorial', 'guide', 'concept', 'example', 'migration'. 'api'=class reference, 'tutorial'=how-to guides, 'guide'=overviews, 'concept'=explanations, 'example'=code samples, 'migration'=porting guides.
moduleNoOptional: Limit search to specific Qt module (e.g., 'qtcore', 'qtwidgets', 'qtqml', 'qtquick', 'qtnetwork')
productNoOptional: Limit search to a specific documentation product (e.g. 'qt', 'qtcreator', 'pyside6'). Omit to search all products.
versionNoOptional: Qt version to search (e.g., '6.10.0', '6.9.0'). Defaults to latest installed version if not specified.
keywordsNoOptional: Array of keywords to search for. Results match ANY keyword. Example: ["button", "signal", "connect"]. Alternative to 'query' for better multi-term matching.
max_resultsNoOptional: Maximum number of results to return (1-10). Default is 3.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / filter / description
      Previous value: -"Optional: Filter by document type. One of 'all', 'class', 'qml', 'function', 'guide'. Default is 'all'. Note: 'function' returns the class reference page that contains the function (there are no function-level pages); for QML, use 'qml'."New value: +"Optional: Filter by document type. One of 'all', 'class', 'qml', 'function', 'guide'. Default is 'all'. Note: 'function' returns the class reference page that contains the function; pass the function name as 'symbol' to the read tool to get just that member. For QML, use 'qml'."
  2. Changed15 schema fields changed
    • addedInput schema / properties / filter / default
      Added value: +""
    • changedInput schema / properties / filter / description
      Previous value: -"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'."New value: +"Optional: Filter by document type. One of 'all', 'class', 'qml', 'function', 'guide'. Default is 'all'. Note: 'function' returns the class reference page that contains the function (there are no function-level pages); for QML, use 'qml'."
    • removedInput schema / properties / filter / enum
      Removed value: -[
-  "all",
-  "class",
-  "qml",
-  "function",
-  "guide"
-]
    • addedInput schema / properties / intent / default
      Added value: +""
    • changedInput schema / properties / intent / description
      Previous value: -"Optional: Prioritizes (not filters) results by type. 'api'=class reference, 'tutorial'=how-to guides, 'guide'=overviews, 'concept'=explanations, 'example'=code samples, 'migration'=porting guides."New value: +"Optional: Prioritizes (not filters) results by type. One of 'api', 'tutorial', 'guide', 'concept', 'example', 'migration'. 'api'=class reference, 'tutorial'=how-to guides, 'guide'=overviews, 'concept'=explanations, 'example'=code samples, 'migration'=porting guides."
    • removedInput schema / properties / intent / enum
      Removed value: -[
-  "api",
-  "tutorial",
-  "guide",
-  "concept",
-  "example",
-  "migration"
-]
    • addedInput schema / properties / keywords / default
      Added value: +[]
    • addedInput schema / properties / max_results / default
      Added value: +0
    • changedInput schema / properties / max_results / maximum
      Previous value: -10New value: +2147483647
    • changedInput schema / properties / max_results / minimum
      Previous value: -1New value: +-2147483648
    • addedInput schema / properties / module / default
      Added value: +""
    • addedInput schema / properties / product / default
      Added value: +""
    • addedInput schema / properties / query / default
      Added value: +""
    • addedInput schema / properties / version / default
      Added value: +""
    • addedInput schema / required
      Added value: +[]
  3. Changed1 schema field changed
    • changedInput schema / properties / filter / description
      Previous value: -"Optional: Filter by document type. Default is 'all'."New value: +"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'."
  4. First observed

TDQS

A3.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With readOnlyHint=true, the safety profile is already covered by annotations. The description does not add behavioral details such as result ranking, limits, query-versus-keywords behavior, or what the search returns; its 'Skip when' clause is routing guidance rather than behavioral disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single compact paragraph with front-loaded trigger conditions and no filler. Every clause serves either to route invocation or to exclude an inappropriate case.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The rich schema covers all parameters, and readOnlyHint covers safety, so the description need not repeat those details. However, there is no output schema and the description does not explain the return format or mention following up with qt_documentation_read for full pages, leaving a workflow gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all 8 parameters are already documented in the input schema. The description adds no parameter-level meaning, which is acceptable at the baseline when the schema carries the full burden.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description makes the tool's verification/search role inferable through concrete triggers such as checking whether a signal/slot/property/default exists and handling Qt 6.7+ or non-core modules. It does not explicitly state 'search Qt documentation' or contrast with the qt_documentation_read sibling, so it is clear but not fully differentiated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit when-to-use conditions in (a), (b), and (c), plus a clear 'Skip when' exclusion for basic QString/QObject/signal-slot syntax questions. The trigger phrases 'docs', 'official', 'verify', and 'check' make invocation conditions highly actionable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Qt Documentation toolsInspect
Try in Browser
Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources