get_mag_hardware

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

No annotations are provided, so the description must cover behavioral traits. It mentions the data type (UINT8), default value (NONE), and a requirement. However, it does not describe failure behavior if USE_MAG is disabled or the exact output format, leaving some gaps.

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, well-structured sentence that includes purpose, special value, requirement, and type. Every part is informative without unnecessary 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 read tool with no parameters and no output schema, the description covers the essential: purpose, one possible value, requirement, and type. However, it could be improved by listing all possible magnetometer hardware options and clarifying the output format.

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 input schema has no parameters, and schema coverage is 100%. There is nothing for the description to add about parameters, so a baseline score of 3 is appropriate.

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 'Get mag_hardware' with the resource 'Magnetometer hardware selection'. It distinguishes itself from siblings like 'set_mag_hardware' and 'calibrate_magnetometer' as a read operation, and explains the special value 'NONE' and requirement 'USE_MAG'.

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 specifies the prerequisite 'Requires: USE_MAG', which guides when to use this tool. However, it does not explicitly contrast with alternative tools like 'set_mag_hardware' or note when not to use it.

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