aedt_set_variable

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

No annotations provided, and the description only mentions the naming convention. It fails to disclose side effects, error conditions, or permissions. For example, it doesn't state whether setting a variable triggers recomputation or what happens if the variable doesn't exist.

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 concise, consisting of one clear sentence and a helpful instruction. Every word adds 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?

Given the tool has 6 parameters, an output schema, and many sibling tools, the description is severely lacking. It does not mention return values, parameter formats, or relationships to other operations. Users must guess how to use it correctly.

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?

With 0% schema description coverage, the description adds minimal meaning beyond parameter names. It explains only the name prefix rule, but 'expression', 'description', 'sweep', 'hidden', and 'read_only' are left completely uninterpreted.

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 it sets a design or project variable, with a specific naming convention for project variables. However, it doesn't clarify whether this creates or modifies an existing variable, and lacks differentiation from sibling tools like 'aedt_create_output_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?

No guidance on when to use this tool versus alternatives such as 'aedt_get_variables' or 'aedt_create_output_variable'. The description does not provide context for selecting this tool over similar ones.

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