netmiko.read_device_output

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

No annotations provided, so the description carries the full burden. It describes the pagination mechanism: response header with line range and total line count, continuation hint for next offset, and a warning about premature totals. This is relevant behavioral information beyond the tool name.

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 concise at 4 sentences, with a clear front-loaded purpose and a bolded 'IMPORTANT' warning. No redundant phrasing; every sentence adds value. Could be slightly more structured, but it's efficient.

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 existence of an output schema, the description adequately covers the pagination behavior and provides a critical prerequisite (get_metadata). It does not explicitly mention error handling or file existence, but the output schema likely covers return values. The description is sufficiently complete for an agent to use the tool correctly.

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 the baseline is 3. The description adds value by explaining the pagination behavior (continuation hint) which helps the agent understand how to use the offset and limit parameters effectively. This goes beyond the schema's parameter 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?

The description clearly states the verb and resource: 'Read a previously saved output file for one device, with pagination.' This distinguishes it from sibling tools like send_show_command (which sends commands) and list_device_outputs (which lists files).

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?

Explicitly instructs to call netmiko.get_metadata FIRST when the user message involves network devices. Also provides guidance on pagination (do not report total based on incomplete pages). Does not explicitly mention alternatives for when not to use this tool, but the context is clear.

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