hcl_read_qos

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

The annotations already fully declare the safety profile (readOnly, idempotent, non-destructive, closed-world), so the description's main added value is the qualifier 'native user-defined,' clarifying it returns user-configured rather than default QoS objects. It says nothing about error behavior for unbound devices or the shape of results.

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?

A single efficient sentence with the resource and scope front-loaded and no filler. It is arguably too short for the amount of parameter ambiguity it leaves, but nothing in it is wasted.

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 read-only tool with no output schema the description covers what is retrieved, but it leaves the key precondition ('bound device') implicit and provides no indication of scope or filtering behavior tied to project_path/topology. Adequate but with clear gaps.

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 description coverage is 0% and none of the three parameters (project_path, topology, device) are documented in either schema or description. The description only echoes 'device' and hints it must be bound, leaving project_path and topology entirely unexplained.

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 (Read) and concrete resources (traffic classes, behaviors and policies) scoped to 'one bound device,' which separates it from neighboring read tools like hcl_read_vlans and hcl_inspect_ports. It stops short of naming a sibling alternative but the subject matter is unambiguous.

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 phrase 'from one bound device' implies the precondition that a device must already be bound in the topology, but there is no explicit when-to-use guidance, no mention of what to do if the device is unbound, and no named alternatives for related QoS inspection.

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