sdr_set_gain

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

No annotations are supplied, so the description carries the full behavioral burden and mostly does not: it does not say whether the device must be connected, whether the change takes effect mid-stream, what units/ranges are valid, or which devices support 'auto'. Only the value format is disclosed.

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?

One short, front-loaded sentence with no filler. It is concise, though the brevity comes at the cost of any operational detail.

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 mutation tool with no annotations, no output schema, and no stated preconditions, the description leaves out essential context: valid gain range, connection requirement, and effect on an active stream. A single extra clause about prerequisites would substantially raise usability.

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?

The single parameter is described inline in the schema (number 'Gain in dB' or enum 'auto'), so the schema already carries its meaning. The description only restates that structure without adding range, limits, or device-specific caveats.

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: setting SDR gain, with accepted value types (dB number or 'auto'). It is separable from most siblings, though it does not explicitly distinguish itself from hackrf_set_tx_gain, which could be confused with the same hardware.

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?

No guidance on when to use this versus hackrf_set_tx_gain, whether the SDR must be connected first (as sdr_connect implies), or whether it applies to receive gain only. The agent must infer all preconditions.

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