QMetry: Fetch QMetry Project Info

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

Annotations declare readOnlyHint, idempotentHint, destructiveHint consistent with fetching. Description adds behavioral details like 'extract viewId from latestViews.TC.viewId' and 'use empty string as folderPath for root directory', exceeding annotation-only info.

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

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

Well-structured with clear sections (Toolset, Parameters, Output Description, Use Cases, Examples, Hints). Purpose is front-loaded. Slightly verbose but all content is useful.

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

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

For a simple tool with one parameter and no output schema, description provides output description, use cases, and hints that fully prepare an agent to use it correctly. All necessary context is covered.

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

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

Schema covers 100% with description of projectKey parameter. Description adds usage examples (default vs specific key) and context when to use each, enhancing meaning beyond schema.

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

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

Description clearly states verb 'Fetch', resource 'QMetry project info', and key fields 'viewId and folderPath needed for other operations'. It distinguishes from sibling tools like qmetry_fetch_qmetry_list_projects which lists all projects.

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

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

Explicit 'Use Cases' section lists when to use this tool (get config before fetching test cases, retrieve viewIds, etc.). 'Hints' advise to always call this first when viewId/folderPath are unknown, and how to handle defaults, providing clear context vs alternatives.

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