set_align_mag

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

No annotations are provided, so the description must disclose behavioral traits. It implies mutation ('Set') but does not state whether the setting is persistent, requires permissions, or has side effects. The prerequisite is noted but insufficient for a mutation tool.

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 very concise at one line with parenthetical notes. It front-loads the action and includes essential prerequisites and type info. However, it could be better structured with a more complete sentence.

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 no output schema and the tool is a setter with a non-obvious parameter (align_mag), the description lacks context about what 'align_mag' is, how it affects the magnetometer orientation, or the range of valid values. This is insufficient for an agent to confidently set the correct value.

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 schema has 100% parameter coverage (one param with description 'Value for align_mag (UINT8)'). The description adds '[UINT8, default: DEFAULT]', which indicates type and default but does not clarify valid values (e.g., range 0-255) or what 'DEFAULT' means. This adds minimal value beyond the schema.

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 'Set align_mag: Magnetometer orientation,' providing a specific verb and resource. It distinguishes from the sibling get_align_mag via the set/get naming convention. However, it does not differentiate from other similar set_* tools beyond the name.

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 a prerequisite (Requires: USE_MAG) but gives no explicit guidance on when to use this tool versus alternatives like get_align_mag or other set tools. No when-not-to-use or context.

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