find_path

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

Discloses algorithm (BFS) and data source (LLDP-discovered topology). No annotations provided, so description carries full burden. Could mention error handling or no-path scenarios but adds meaningful context.

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?

Extremely concise: first sentence states purpose, second adds algorithm, then parameter list. No wasted words.

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?

Output schema exists, so return values not needed. Covers algorithm and data source. Lacks details on error conditions or performance, but sufficient for a simple two-param tool.

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 has 0% description coverage; description provides inline definitions for source and target as device names. Adds meaning but is minimal (no examples or format constraints).

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 finds the shortest path between two devices, using BFS on LLDP-discovered topology. This distinguishes it from sibling topology tools like show_topology or discover_topology.

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 vs alternatives (e.g., show_topology for full view). Usage is implied but no exclusions or comparison provided.

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