rca_guide_list

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false. Description adds 'List all...' which is consistent but provides no additional behavioral disclosure such as pagination or auth requirements beyond the schema's required 'token' parameter.

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?

Two-line description plus structured Args/Returns section. Purpose is front-loaded. Every sentence adds value with 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 simple filtered list tool, the description covers core behavior and return fields. However, missing explanation of auth parameters (token, client_id) slightly reduces completeness. Output schema exists to detail returns, compensating partially.

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 0%, meaning description must compensate. Description mentions optional equipment_type and tags filters but omits explanation of required 'token' and default 'client_id' parameters. Only 2 of 4 parameters are addressed, adding minimal value over the 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 'List all ingested troubleshooting guides with optional equipment_type/tag filters', which is a specific verb+resource and distinguishes from siblings like rca_guide_search (search) and rca_guide_get (get specific guide).

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?

No explicit guidance on when to use this tool vs alternatives like rca_guide_search or rca_analysis_list_results. The description implies usage for listing with filters, but does not provide exclusions or context.

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