show_lldp_neighbors

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

No annotations are provided, so the description carries the full burden. It discloses that the tool returns neighbor info (system name, port ID, capabilities), which is accurate for a read operation. However, it does not mention prerequisites (e.g., LLDP must be enabled) or any side effects.

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 extremely concise: two sentences plus a one-line parameter definition. No extraneous information. Key details are front-loaded in the first sentence, making it efficient for agent consumption.

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's simplicity (one parameter, output schema present), the description is complete: it states the purpose, the returned information, and the parameter meaning. No additional context is necessary for correct invocation.

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 0%, but the description augments the parameter 'device' by specifying it as 'Name of the device as defined in devices.yaml', providing context beyond the schema's bare type definition. This helps the agent understand the expected source for device names.

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 shows LLDP neighbor discovery information, specifying the verb 'Show' and the resource 'LLDP neighbor discovery information'. It details the output: connected neighbors with system name, port ID, and capabilities, distinguishing it from other neighbor-related tools like show_device_neighbors.

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 mentions it is 'useful for topology discovery', implying a use case, but does not explicitly state when to use this tool versus alternatives like show_device_neighbors or show_topology. No exclusions or when-not-to-use guidance is provided.

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