set_esc_sensor_halfduplex

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

The description discloses the effect (half-duplex UART enable) and the default value (OFF), but lacks details on side effects (e.g., does it change other settings?), persistence, or error conditions if the requirement is unmet. With no annotations, the description carries the full burden but is only moderately transparent.

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 extremely concise: one sentence stating the action, a note on the requirement, and a type/default spec. There is no fluff, and the key information is front-loaded.

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?

Given the tool has a single parameter, no output schema, and no annotations, the description is adequate but incomplete. It does not mention whether the setting is persistent, requires a reboot, or returns any confirmation. The presence of a sibling getter (get_esc_sensor_halfduplex) suggests a readback pattern, but the setter description does not connect to it.

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 description adds meaning beyond the schema by specifying the default (OFF) and the data type (UINT8), but it does not clarify the valid range or mapping (e.g., 0/1 for OFF/ON). The schema's parameter description is minimal ('Value for esc_sensor_halfduplex (UINT8)'), so the description provides some additional context but not full clarity.

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 action ('Enable half-duplex UART for ESC sensor') and the specific hardware context (BLHeli32/AM32 telemetry on a single wire). It differentiates itself from sibling set tools like set_esc_sensor_current_offset by explaining the unique purpose.

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?

While the description mentions a compile-time requirement (USE_ESC_SENSOR) and provides hardware context, it does not explicitly guide the agent on when to use this tool versus alternatives like get_esc_sensor_halfduplex or other set commands. The usage context is implied but not clearly delineated.

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