set_motor_pwm_rate

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

No annotations are provided, so the description carries the burden. It discloses the parameter range and default but does not mention effects after setting (e.g., immediate effect or reboot needed) or prerequisites.

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 a single concise sentence with a bracketed note. Every word is functional, and there is no redundant information.

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 only one parameter and no output schema, the description is largely complete. It lacks explanation of what happens after invocation (e.g., immediate effect or reboot), but for a simple setter, it covers the essential aspects.

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%, and the description adds meaning by specifying the type (UINT16) and default value (480) beyond the schema's min/max/description. This helps the agent understand the expected value format.

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 that this tool sets the PWM frequency for brushed motor mode. It explicitly distinguishes it from DSHOT protocols, which is a key differentiator among the many sibling set_* tools.

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 indicates it is for brushed motor mode and not relevant for DSHOT protocols, giving context on when to use. However, it does not explicitly mention when alternatives like motor_set or other set tools might be preferred, though the specificity helps.

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