netmiko.list_devices

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 clearly states the operation is a list (read-only) and that it operates 'without credentials,' which is a notable behavioral trait. It does not mention pagination, rate limits, or other potential behaviors, but the simplicity of the tool makes this sufficient.

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 with two sentences plus a short IMPORTANT note. Information is front-loaded: the essential action comes first, followed by critical usage instructions. Every sentence earns its place with no redundancy.

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 optional parameter with 100% schema coverage, an output schema present, and no annotations needed for a read-only list), the description covers all necessary aspects: purpose, when to use, behavioral trait (without credentials), and relationship to sibling tools. The output format is covered by the output schema, so no further detail is needed.

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 100%, so baseline is 3. The description reinforces the parameter's purpose ('discover exact device names') but does not add new semantic information beyond what the schema's description already provides ('all, a group name, or a device name'). The emphasis on using exact names is helpful context but not additional parameter semantics.

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 devices from the inventory without credentials, with a specific purpose to discover exact device names. It distinguishes from siblings by emphasizing that device names are the only handle other tools accept, and it notes the IMPORTANT prerequisite to call netmiko.get_metadata first.

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?

Explicit usage guidance is provided: 'Use this to discover exact device names before running a command' and 'Device names are the only handle the other tools accept — never pass an IP address or a hostname you inferred.' The IMPORTANT instruction to call netmiko.get_metadata first for network-related messages further clarifies when and how to use the tool.

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