list_quality_gates

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

With no annotations provided, the description carries the behavioral disclosure burden. It states that the tool returns a list with ID, name, and built-in/custom flags, and requires SONARCLOUD_ORGANIZATION to be set. This adds useful context beyond the empty schema, though it does not explicitly state 'no side effects' — but the read-only nature is clear from 'list'.

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?

The description is compact, with a clear first sentence stating the purpose, followed by return details and a prerequisite, and finalized with an example. Every sentence adds value and there is no 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?

For a zero-parameter tool with an output schema, the description covers the essential context: what it does, what it returns, the environment variable prerequisite, and an example. No additional context is needed for execution.

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?

The schema has zero parameters, and 100% of properties are described (trivially). The description goes beyond the schema by providing an example invocation 'list_quality_gates()' and explaining the env var requirement, which helps the agent understand how to call the tool.

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 uses the specific verb 'Enumerate' and names the resource 'all gates in the organization', clearly defining the scope. It distinguishes itself from sibling tools like 'show_quality_gate' (singular) or 'search_quality_gates' (filtered) by emphasizing 'all' and 'basic metadata and built-in flags'.

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?

The description clearly implies the usage context: use this when you need every quality gate in the organization, not a specific one. It also notes the environmental prerequisite (SONARCLOUD_ORGANIZATION) and provides an example. However, it does not explicitly mention when to prefer a sibling like 'search_quality_gates'.

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