QMetry: Fetch Quality Gate Configuration

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

Annotations declare readOnlyHint, idempotentHint, and non-destructive. The description adds useful context beyond annotations: expected output structure (assessment scope, gate criteria, thresholds) and an error condition when AI Agent is not enabled. No contradiction found.

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 (description, parameters, use cases, examples, hints) and front-loaded with the main purpose. However, the Parameters section largely duplicates the input schema descriptions, adding some redundancy.

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?

With no output schema, the description provides expected output indication ('gate configuration object with assessment scope, gate criteria, and thresholds'), use cases, and sequencing instructions. This is sufficient for an agent to select and invoke the tool effectively.

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 coverage is 100%, so the baseline is 3. The description adds value with concrete examples, clarifies that projectId is the internal numeric identifier not the project key, and restates required parameters in prose, exceeding schema descriptions.

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?

The description clearly states the tool fetches quality gate configuration for a project and AI agent, with a specific scope (assessment scope and gate criteria). This distinguishes it from the sibling tool qmetry_execute_quality_gate_report.

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?

Lists three concrete use cases and explicitly advises calling this tool before 'Execute Quality Gate Report' in the Hints section. This provides clear when-to-use guidance and references the alternative.

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