listSitesCableTestSwitchesIncrementResults

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

No annotations provided, so description carries full burden. It states 'Get cable test incremental results' but doesn't disclose what the results contain (e.g., format, pagination) or that it's a read-only operation. Lacks behavioral context.

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?

Single sentence with no superfluous words. Front-loaded with the core action. Highly concise while still clear.

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?

No output schema and no explanation of what 'incremental results' means vs 'full results' (getCableTestFullResults). Lacks context about return values or relationship to sibling tools. Incomplete for a tool with 3 params and no output schema.

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 descriptions cover 100% of parameters, providing clear explanations for siteId, switchMac, and customHeaders. The description adds minimal extra meaning beyond the schema (e.g., 'for a switch' aligns with switchMac). Baseline 3 is appropriate.

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 verb 'Get' and the resource 'cable test incremental results for a switch.' It distinguishes from sibling tools like getCableTestFullResults (full vs incremental) and getCableTestLogs (logs vs results), and the switch-specific focus is evident.

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 guidance on when to use this tool vs alternatives like getCableTestFullResults or getCableTestLogs. No mention of prerequisites or typical use cases.

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