set_dshot_burst

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

Describes setting the mode and AUTO behavior, but lacks details on side effects, permissions, or post-set behavior. Annotations absent, so description carries full burden.

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?

Very concise: two sentences plus parenthetical. Front-loaded with action. Could be better structured but efficient.

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?

Covers what it does, default, and prerequisites, but does not explicitly list allowed values (ON, OFF, AUTO). Output schema absent; description sufficient but not fully comprehensive.

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?

Adds meaning beyond schema: explains AUTO selection, default value, and required compile defines. Schema only describes parameter as string for UINT8.

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?

Clearly states 'Set dshot_burst: DSHOT burst transmission mode' and explains AUTO selection based on hardware. Distinguishes from siblings like set_dshot_bidir, set_dshot_bitbang.

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?

Provides prerequisite (USE_DSHOT + USE_DSHOT_DMAR) and default AUTO, but does not guide when to choose ON/OFF vs AUTO or compare with siblings.

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