switch-list-bydevice

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

No annotations provided, so description carries full burden. It only states 'read-only', which is a minimal behavioral disclosure. It does not mention data freshness (most recently seen), pagination behavior, or potential rate limits. The input schema hints at pagination but description omits this.

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?

The description is a single sentence plus a fragment, totaling 15 words. It is concise and front-loads the key action and resource. However, it could include additional context without becoming verbose.

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?

Given the tool has 15 parameters, no output schema, and no annotations, the description is too brief. It fails to cover the return format, pagination behavior, or how to combine it with sibling tools. More detail is needed for an agent to use it correctly in diverse scenarios.

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?

Input schema has 15 parameters with descriptions covering 100% of them. The description adds the phrase 'most recently seen', which slightly clarifies the data scope. However, the schema already explains each parameter (e.g., filtering by MAC, name, serial) adequately, so the description adds marginal value beyond 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?

The description clearly states it lists LLDP/CDP discovery and topology information per switch port in an organization. The verb 'list' and resource are explicit. However, there are sibling tools like 'devices-list-lldpcdp' and 'get-organization-switch-ports-by-switch' that overlap, and the description does not distinguish itself further.

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. The description does not mention prerequisites, typical use cases, or when not to use it. The 'read-only' note is the only hint, but it's insufficient for an agent to decide among many list tools.

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