switch-list-statuses

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

Description includes '(read-only)' indicating non-destructiveness, which is helpful given no annotations. However, it does not disclose other behaviors like rate limits, authentication needs, or what happens with missing optional parameters.

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 plus parenthetical annotation is concise and front-loaded. Every word is necessary, 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 straightforward list tool, the description is adequate. It explains input (serial, optional filters) and that it returns port statuses. Lacks details on output format (array of objects) but is largely complete.

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% with descriptions for each parameter. Tool description adds no extra meaning beyond the schema, though it clarifies the scope ('all ports'). Baseline score of 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?

Description clearly states verb 'Return' and resource 'the status for all the ports of a switch', giving a specific purpose. However, it does not explicitly distinguish from sibling tools like 'switch-list-ports' which may also return port information.

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 such as 'switch-list-ports' or 'get-organization-switch-ports-by-switch'. No prerequisites or exclusions are provided.

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