read_variable

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

No annotations provided. Description states halt condition but does not explicitly confirm non-destructive nature or error behavior. Adequate but could be more explicit.

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?

Three sentences: action, precondition, parameter details. No wasted words, front-loaded with main purpose.

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 core functionality. Output schema exists but not shown. Missing details on variable-not-found or target-not-halted scenarios, but minimalism is reasonable for a simple read tool.

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?

Single parameter 'name' explained with examples ('counter', 'myStruct.field'). Adds meaning beyond schema's generic 'Name' label.

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?

Clearly states action: 'Read a C/C++ variable from the target by its symbol name.' Differentiates from siblings like write_variable (write) and read_memory (memory, not variable).

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?

Explicit precondition: 'The target must be halted (stopped) for variable reads to work.' Does not mention when not to use or alternatives, but provides necessary context.

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