annotation.define_symbol

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

No annotations are provided, and the description offers no behavioral details: no mention of idempotency, overwrite behavior, side effects, or required permissions. The description fails to carry the burden of transparency.

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 short but underspecified. While it is concise, it sacrifices essential information; every sentence should earn its place, but this one does not provide enough value.

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 tool with 4 parameters, no output schema, no annotations, and a rich set of sibling tools, the description is severely incomplete. It does not explain return values, usage constraints, or how it relates to other annotation tools.

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 schema has 0% description coverage, and the tool description does not explain any parameter (name, address, session_id, symbol_type). The agent cannot determine valid formats or semantics, especially for the non-obvious symbol_type parameter.

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 the action (define) and resource (symbol at address), distinguishing it from siblings like rename_symbol or undefine_symbol. However, it lacks precision on what 'define' entails (e.g., creating a new label, overriding an existing symbol).

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?

No guidance is provided on when to use this tool versus alternatives such as annotation.rename_symbol, annotation.undefine_symbol, or annotation.define_data_var. The agent cannot infer the appropriate context.

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