set_usb_hid_cdc

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

No annotations are provided, so the description must carry the behavioral burden. It indicates the setting is a UINT8 with default OFF, implying a write operation. However, it does not disclose side effects (e.g., requires reboot) or permissions needed.

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 two short sentences plus a parenthetical note. It front-loads the action and then explains context and default. No extraneous words.

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 simple toggle tool with one parameter and no output schema, the description covers the purpose, default, and a use case. It lacks mention of whether a reboot is needed, but overall it is fairly complete.

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 100% for the single parameter 'value', described as 'Value for usb_hid_cdc (UINT8)'. The description adds meaning: explains the value corresponds to enabling HID+CDC and provides the default, beyond the schema's minimal description.

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 verb 'Set' and the resource 'usb_hid_cdc', explains the function (use combined HID+CDC instead of pure CDC), and provides a use case (required for some OTG hosts). This distinguishes it from other set_* siblings.

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 mentions when to use (for OTG host compatibility) but does not explicitly state when not to use or compare with alternatives like set_usb_msc_pin_pullup. Guidance is present but minimal.

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