discover_topology

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

With no annotations, the description must carry behavioral disclosure. It mentions connecting and collecting data, suggesting a read-only operation, but does not explicitly state that it is non-destructive, nor does it discuss authentication, rate limits, or error handling. The behavioral context is minimal.

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?

Two succinct sentences plus a one-line parameter description. Front-loaded with the action and outcome. No redundant or unnecessary information.

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 one parameter and an output schema (implied), the description adequately explains purpose, method, and parameter. It doesn't detail the output format, but that is covered by the output schema. Lacks differentiation from siblings but still functional.

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 0% (only title), but the description clearly explains the 'devices' parameter format (comma-separated) and default behavior (empty = all devices). This adds significant meaning beyond the schema, compensating for the lack of schema descriptions.

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?

Clearly states the tool discovers network topology by collecting LLDP data and building a topology map. The verb 'discover' and resource 'network topology' are specific. Distinguishes from sibling tools like show_lldp_neighbors or show_topology by focusing on discovery and map generation.

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?

Description indicates connecting to devices and collecting LLDP data to build topology, which implies usage for discovery. However, it does not explicitly state when to use this tool versus alternatives (e.g., show_lldp_neighbors for raw data, show_topology for existing map), nor does it provide exclusions or prerequisites.

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