appliance-list-ports

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

No annotations are provided, so the description carries full burden. It only declares read-only behavior in parentheses, but lacks disclosure of pagination, rate limits, authentication needs, error handling, or consequences of invalid inputs.

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 verb and scope, plus a parenthetical note. Zero wasted words, front-loaded with essential info.

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?

With no output schema and no annotations, the description is minimal. It covers the basic purpose but lacks detail on return format, pagination, or error scenarios. Adequate for a simple read operation but not thorough for a multi-tool ecosystem.

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 parameter descriptions already present. The tool description does not add meaning beyond what is in the schema. The 'fields' parameter is documented equally in both. 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?

Description clearly states verb 'List', specific resource 'per-port VLAN settings', and scope 'all ports of a secure router or security appliance'. The suffix '(read-only)' adds precision. It distinguishes from sibling tools like 'switch-list-ports' which target switch ports.

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 versus alternatives. While sibling names imply context (e.g., 'switch-list-ports' for switches), the description does not state when to choose this over other list tools or provide exclusions.

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