uidf.set_user_var_value

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

No annotations are provided, so the description must fully disclose behavioral traits. It only states 'set', implying mutation, but fails to describe side effects, idempotency, state requirements, error conditions, or whether the operation is destructive. For a mutation tool with no annotation support, this is insufficient.

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 a single sentence, which is concise, but it sacrifices essential detail. It is not verbose, but every sentence should earn its place; here, the sentence fails to provide enough information to be fully helpful. A 3 reflects adequate conciseness with a cost to completeness.

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?

Given the tool's complexity (7 parameters, 6 required, no output schema, 0% schema description coverage), the description is woefully incomplete. It does not explain parameter meanings, return values, side effects, or usage context. The rich sibling environment (e.g., uidf.parse_possible_value, uidf.clear_user_var_value) is not leveraged. The description fails to meet the basic information needs of an AI agent.

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?

Schema description coverage is 0%, meaning the JSON schema provides no explanations for the 7 parameters (after, state, value, def_addr, session_id, variable_name, function_start). The tool description adds no parameter-level meaning whatsoever, leaving the agent to guess semantics from parameter names alone. This is a critical gap for a tool with 6 required parameters.

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 'Set function user variable value' clearly states the verb (set) and resource (function user variable value), distinguishing it from siblings like uidf.clear_user_var_value and uidf.list_user_var_values. It is specific enough to convey the tool's function without ambiguity.

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?

The description provides no guidance on when to use this tool vs alternatives (e.g., when to set vs clear or list user variable values). It does not mention prerequisites, context, or exclusions, leaving the agent to infer usage solely from the tool name.

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