netbox_device_interfaces

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

readOnlyHint=true is already in annotations, so the safety profile is free; the description instead adds non-obvious behavior — the exact return envelope, the truncation flag, and the operational caveat that truncated results invalidate drift analysis. It stops short of describing auth requirements or pagination beyond the limit knob, so not a 5.

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?

Front-loaded with a [READ] tag, purpose, differentiation, return shape, and caveat in a handful of tight lines. Every sentence carries actionable information; no filler.

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?

With no output schema, the description supplies the full return contract ({interfaces, returned, limit, truncated}) plus the crucial truncation caveat, and documents both parameters. There is no gap an agent would need to guess at before calling this 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 coverage is 0%, so the description must compensate, and it does: 'device' is pinned as an exact NetBox name with a pointer to netbox_list_devices, and 'limit' is explained as a max count with its default. It doesn't clarify whether limit is an offset-style pagination or a cap on a single page, hence 4 rather than 5.

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?

States a specific verb and resource ('List a NetBox device's interfaces') plus the fields returned, and explicitly distinguishes the source-of-truth inventory from the live-state sibling get_interfaces. An agent can route between the two without opening either schema.

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?

Names the exact use case (drift comparison against get_interfaces), points to netbox_list_devices for device discovery, and gives an explicit when-not rule: do not report drift from a truncated list, re-run with a higher limit. This is genuine routing guidance, not implied context.

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