interface_status

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

With no annotations, the description carries the full transparency burden. It discloses a non-obvious behavior: with top set, the entire table is fetched and ranked before truncation, and truncated is a measured flag rather than inferred. The [READ] prefix signals a non-mutating operation, though authentication, rate limits, and error behavior are not mentioned.

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 core purpose is front-loaded in the first line, and the top behavior is explained in a compact, structured way. The truncated-flag detail earns its place, though the description could be slightly tighter by adding an explicit 'returns' phrase.

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?

The description covers the two parameters and a key behavior, but with no output schema it never describes the shape of the returned interface data, ordering, or default top size. For a simple 2-parameter tool it is nearly sufficient, yet the missing return contract is a real gap.

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%, but the Args section fully compensates by explaining top as 'top-N interfaces by peak utilization' and target as a 'SolarWinds target name from config' with default behavior. This adds meaningful semantic detail beyond the bare 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 identifies the resource (Orion.NPM.Interfaces) and the action (status + utilization) with a [READ] prefix, making the purpose clear. It is naturally distinguishable from sibling tools like node_status and volume_status, though it does not explicitly differentiate itself from the similar 'topn' tool.

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?

The description provides parameter-level guidance like 'omit for the default' but gives no explicit direction on when to choose interface_status over alternatives such as topn or node_status. An agent would have to infer the appropriate use case from the resource name alone.

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