write_variable

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

Discloses key behaviors: writes a scalar variable, requires prior load_elf, and specifies value format (hex or decimal). Lacks details on error handling or side effects, but is sufficient for a straightforward write operation given no annotations.

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?

Two sentences, no redundancy. Every sentence provides essential information: operation, prerequisite, value format, and alternative tool.

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?

Covers all necessary aspects for a simple write tool: what it writes, prerequisites, value format, and when to use an alternative. Output schema likely handles return values.

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?

Adds value beyond schema by explaining the format for 'value' (hex or decimal) and that 'name' refers to a global/static variable. Compensates for 0% schema description coverage.

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 writes a scalar global/static variable by name, with a specific verb ('write') and resource ('variable'). It distinguishes from write_memory for arrays/structs, ensuring no confusion with sibling tools.

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 prerequisite 'requires load_elf first' and directs users to use 'write_memory for arrays/structs' for alternatives. This provides clear when-to-use and when-not-to-use guidance.

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