set_user_variable

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

The description discloses that setting value to None deletes the variable and mentions the input dialog behavior. However, it does not address other behavioral aspects like persistence, permissions, or error handling. No annotations are provided to supplement.

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 structured with Args and Returns sections, but includes some redundant technical details (e.g., 'SetUserVar'). It is adequately short but could be more concise.

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 setter tool with 3 parameters and an output schema (returning a string), the description covers the core behavior, including deletion and dialog. It does not mention persistence or scope, but 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?

Given 0% schema description coverage, the description adds meaningful context: var_name should start with '$, value can be numeric, text, or None, and input_dialog triggers a prompt. This goes beyond the raw schema types.

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 tool sets a user-profile-specific variable, using the verb 'set' and specifying the scope. However, it does not explicitly differentiate from sibling tools like 'set_variable' or 'add_user_variable', which are contextually similar.

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. The description implies it is for user-specific variables, but lacks explicit when-to-use or when-not-to-use instructions.

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