Skip to main content
Glama
Sign In

Qt Documentation

by io.qt.qt-docs-mcp
OverviewDiscussionsAdmin

qt_documentation_read

Read-only

Read the full content of a specific Qt documentation page, or a single member of it with 'symbol'. Use the filename shown in search results.

Input Schema

NameRequiredDescriptionDefault
fileYesDocumentation page filename from a search result (e.g. 'signalsandslots.html'), or a module-relative path (e.g. 'qtcore/qobject.html').
symbolNoOptional: Return only one member's documentation instead of the whole page. A name (e.g. 'singleShot', 'anchors.fill', 'AlignmentFlag', 'onCompleted') returns every overload and any property of that name; an enum constant or property access function returns its enum or property. An anchor, shown as {#anchor} after each signature (e.g. 'singleShot-5'), returns that block only. An unknown name returns the page's member list.
versionNoOptional: Qt version to read from (e.g., '6.10.0'). Defaults to the latest installed version.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / symbol
      Added value: +{
+  "default": "",
+  "description": "Optional: Return only one member's documentation instead of the whole page. A name (e.g. 'singleShot', 'anchors.fill', 'AlignmentFlag', 'onCompleted') returns every overload and any property of that name; an enum constant or property access function returns its enum or property. An anchor, shown as {#anchor} after each signature (e.g. 'singleShot-5'), returns that block only. An unknown name returns the page's member list.",
+  "type": "string"
+}
  2. Changed3 schema fields changed
    • changedInput schema / properties / file / description
      Previous value: -"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."New value: +"Documentation page filename from a search result (e.g. 'signalsandslots.html'), or a module-relative path (e.g. 'qtcore/qobject.html')."
    • addedInput schema / properties / version / default
      Added value: +""
    • changedInput schema / properties / version / description
      Previous value: -"Optional: Qt version to read from (e.g., '6.10.0', '6.9.0'). Defaults to latest installed version if not specified."New value: +"Optional: Qt version to read from (e.g., '6.10.0'). Defaults to the latest installed version."
  3. First observed

TDQS

A4/5.0
Behavior3/5

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

readOnlyHint=true already declares the safe-read profile, and the description is consistent with it while adding that the whole page content (not a snippet) is returned and that 'symbol' narrows to a member. It does not mention output format, page size, or truncation behavior, so the added behavioral context is modest beyond the annotations.

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?

Two short sentences, front-loaded with the primary action and immediately followed by the narrowing option. Every clause carries information; nothing is redundant with the title or restates the name.

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

Completeness4/5

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

For a read-only, single-resource fetch with a fully documented schema and no output schema, the definition covers what is fetched and how to narrow it. Only minor gaps remain, such as whether content is returned raw HTML or Markdown and how large pages are handled.

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%, and the schema already explains all three parameters in depth, including symbol fallback behavior and version default. The description's 'Use the filename shown in search results' adds workflow context but little that the schema does not already say, so the baseline 3 applies.

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

Purpose5/5

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

States a specific verb and resource ('Read the full content of a specific Qt documentation page') and covers the member-level variant via 'symbol'. It also implicitly separates itself from the sibling by pointing at search results as the source of the filename, so an agent can tell read apart from search.

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

Usage Guidelines4/5

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

Gives clear context: use the filename shown in search results, and add 'symbol' when only one member is wanted. No explicit when-not clause or naming of the sibling alternative, but the workflow ordering (search first, then read its filename) is unambiguous.

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