get_dshot_burst

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

With no annotations, the description carries the full burden. It adds that AUTO dynamically selects based on hardware capability and specifies the return type (UINT8) and default (AUTO). However, it does not disclose possible values beyond AUTO or error handling when prerequisites are unmet.

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 efficient sentence that front-loads the key information: what it retrieves, the behavior of AUTO, compile requirements, and type/default. No fluff.

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 is a simple getter with no parameters and no output schema, the description covers the essential aspects. It could be improved by listing the possible values or stating that the setting is read-only, but still provides adequate context for an agent.

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 tool has zero parameters, so the baseline is 4. The description does not need to explain parameters and adds context about the return value type and default.

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 tool retrieves the 'DSHOT burst transmission mode' and explains that 'AUTO selects based on hardware capability'. It distinguishes this from sibling getters like get_dshot_bidir or get_dshot_bitbang by specifying the exact resource and its behavior.

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 implies the tool is for reading by naming it 'Get dshot_burst' and includes the compile-time requirements 'USE_DSHOT + USE_DSHOT_DMAR', but does not explicitly state when to use this tool versus alternatives like the setter or other getters.

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