set_baro_i2c_device

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

No annotations provided; description adds value by specifying parameter type, range, and default beyond the schema. Does not disclose side effects or error conditions, but for a simple setter, this is adequate.

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?

Single sentence with inline key details (parameter type, range, default, and requirement). Front-loaded and compact with no wasted 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?

Given no output schema and simple parameter, the description is complete. It tells what it sets and the required feature. Could mention if a reboot is needed, but not essential for a parameter setter among many similar siblings.

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 already covers parameter with description, min, max. Description adds 'UINT8' type and default value, but no additional semantic depth beyond the schema's structured data.

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 it sets the I2C bus number for the barometer, specifying the parameter is UINT8 with range 0-5 and default 0. This distinguishes it from siblings like 'set_baro_i2c_address' which sets the address.

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?

Explicitly notes the requirement 'USE_BARO' feature, indicating when the tool is applicable. Implicitly contrasts with getter sibling. Lacks explicit when-not-to-use or alternative tools, but context is clear among similar set_ tools.

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