Skip to main content
Glama

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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryNoSearch query for Qt documentation (e.g., 'Animation', 'QTimer', 'signal slot'). Optional if 'keywords' is provided.
filterNoOptional: 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'.
intentNoOptional: Prioritizes (not filters) results by type. '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.

TDQS

B3.3/5.0
Behavior2/5

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

With no annotations provided, the description carries the full burden of disclosing behavioral traits. It only explains when to use the tool, not what the tool actually does (e.g., returns a list of documentation pages, performs exact or fuzzy matching, network access). It does not mention the return format, pagination, or any side effects. This is a significant gap for an AI agent needing to know what to expect.

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

Conciseness4/5

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

The description is a single structured sentence with clear (a), (b), (c) conditions and a skip clause. It is efficient and front-loaded with the action trigger. It loses a point for being a bit dense with multiple conditions, but overall it is concise and well-organized.

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

Completeness2/5

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

With 8 parameters, no output schema, and no annotations, the description needs to explain what the tool returns and how the results should be interpreted. It does not. The usage triggers are useful but incomplete for a search tool—there is no mention of return values, result ordering, or how to use the output for verification. This is a clear 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%, and the parameter descriptions are detailed (e.g., 'filter' enum explains that 'function' returns the class reference page containing the function). The tool description itself adds no additional parameter semantics beyond the schema. Baseline 3 is appropriate since the schema does the heavy lifting.

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 tool name 'qt_documentation_search' clearly implies the action of searching Qt documentation, and the description provides specific triggers (e.g., 'when you're about to claim a signal/slot/property/default exists'). However, the description never explicitly states 'Searches Qt documentation' as a function, relying on the name and schema. The conditions help differentiate from the sibling qt_documentation_read, but not explicitly.

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?

The description gives explicit when-to-use conditions (a, b, c) and a skip condition ('Skip when: the question is about basic QString/QObject/signal-slot syntax'). This is strong usage guidance. However, it does not name the sibling tool qt_documentation_read as an alternative for reading full documentation pages, so it lacks the direct alternative recommendation that would merit a 5.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A3.9/5.0
Disambiguation5/5

The two tools have clearly distinct purposes: one searches documentation and the other reads a page's content. There is no overlap or confusion.

Naming Consistency5/5

Both tool names follow the consistent pattern 'qt_documentation_' followed by a verb ('read' and 'search'), adhering to verb_noun style.

Tool Count3/5

With only 2 tools, the server feels slightly thin for a documentation domain, but the tools cover the basic workflows of searching and reading, earning a borderline score.

Completeness3/5

The server lacks tools for listing categories, browsing modules, or navigating to specific sections, which are notable gaps for a documentation service. However, the search and read workflow covers the core tasks.

Resources