devices-list-lldpcdp

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

With no annotations, the description must disclose behavioral traits. It only states 'read-only,' indicating no mutations, but does not mention authorization requirements, rate limits, error responses, or what happens if the device serial is invalid. This is insufficient for a tool listing LLDP/CDP info.

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 very concise at one sentence plus a parenthetical note. There is no fluff, and every part carries meaning. However, it lacks structure (e.g., paragraph breaks or bullet points), which would be beneficial for complex tools but acceptable here.

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 no output schema, the description should explain what is returned, but it does not. It also does not mention any prerequisites (e.g., device must support LLDP/CDP). The tool is relatively simple, but the missing return information leaves the agent unclear on what to expect from the response.

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 description coverage is 100% (both parameters have descriptions). The description adds nothing beyond the schema: 'serial' is required with minLength, 'fields' is an optional array with available values noted. Baseline 3 applies as the schema already provides adequate meaning.

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 tool lists LLDP and CDP information for a device, and the '(read-only)' note adds clarity. It distinguishes from sibling tools that list other types of device information. However, it does not elaborate on what LLDP/CDP are, which might be assumed but is acceptable.

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 versus alternatives. The description simply states what it does without indicating when it is appropriate or when to avoid using it. No exclusions or mention of other tools that might be more suitable for different scenarios.

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