netbox_device_interfaces

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

With no annotations provided, the description carries full burden. It declares read-only intent with '[READ]', describes the return format (including 'truncated' bool), and explains truncation behavior. This is thorough, though it doesn't cover authentication or error scenarios.

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 well-structured with a summary line, usage context, return format, caveat, and parameter explanations. Every sentence adds value without 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?

For a simple list tool with no output schema, the description covers the return format and truncation behavior. It could mention sorting or pagination beyond limit, but overall it's sufficiently complete for its complexity.

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%, so the description must compensate. It clearly explains both parameters: device as exact name with a reference to netbox_list_devices, and limit with default value and purpose. This adds significant meaning beyond the minimal schema.

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 (List), resource (NetBox device's interfaces), and key fields (name, type, enabled, description). It distinguishes itself from the sibling get_interfaces tool by noting this is the source-of-truth inventory for drift detection.

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?

It explicitly instructs to compare against get_interfaces to spot drift, warns against reporting drift from a truncated list, and suggests re-running with a higher limit. It also specifies that the device parameter requires an exact name from netbox_list_devices.

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