getDashboardSwitchSummary

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

No annotations are provided, so the description carries full burden. It indicates a read operation (Get) and lists returned data, but does not explicitly state read-only nature, side effects, error conditions, or auth requirements. Adequate but could be more explicit.

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 clear front-loaded purpose and enumerated data fields. No redundant information. Efficient and scannable.

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 but description lists specific return fields, sufficient for a summary tool. Parameters are fully covered. Missing details on error handling or format, but overall complete for expected use.

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 for both parameters (siteId and customHeaders) are present and add context beyond name/type. siteId description explains default behavior and how to get IDs; customHeaders notes it's rarely needed. This adds value.

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 action 'Get' and the resource 'switch summary for a site dashboard', listing specific data fields (switch count, ports, PoE, bandwidth). This differentiates it from sibling tools like getDashboardPoEUsage or getDashboardWifiSummary.

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 implies usage via 'for a site dashboard' but lacks explicit when-to-use or when-not-to-use guidance versus sibling tools. The siteId parameter description provides some guidance on default site and discovery via listSites, but no alternative comparisons.

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