get_ibata_offset

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

With no annotations provided, the description carries full burden for behavioral transparency. It merely states the value range and default but omits any mention of side effects, safety profile (e.g., read-only nature), or required permissions. For a tool that likely just reads a register, it fails to explicitly confirm it is non-destructive.

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 extremely concise: one sentence with an inline format specification. Every word is informative; no fluff or redundancy.

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-only tool with no parameters and no output schema, the description covers the essential information: what is retrieved (offset), its unit, range, and default. It could be improved by explicitly noting it is a safe read operation, but given the tool's simplicity, it is reasonably complete.

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 zero parameters (schema coverage 100% vacuously). The description adds value by explaining the meaning of the returned value: unit (millivolts), data type (INT16), range (-32000 to 32000), and default (0). This exceeds what the empty schema provides.

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 retrieves the ibata_offset, identifying it as the ADC current sensor offset in millivolts. This specific verb-resource pairing distinguishes it from hundreds of other get_* sibling tools that retrieve different parameters.

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?

Usage is implied: call it when you need the current sensor offset. However, there is no explicit guidance on when not to use it or how it compares to alternatives like set_ibata_offset or other get_* tools. The context of sibling tools includes many similar getters, but the description does not differentiate usage scenarios.

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