aedt_get_output_variable

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

With no annotations provided, the description must fully disclose behavioral traits. It states 'Read,' implying a read-only operation, but fails to mention any side effects, required session state, error conditions, or output format. This is insufficient for a tool with no annotation support.

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 at 6 words, but it lacks necessary detail. While brevity is valued, this is under-specification rather than efficient communication. Every sentence should earn its place, but here there is only one sentence that provides minimal information.

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 2 parameters (1 required), no annotations, and an output schema (not shown), the description is too brief to be complete. It doesn't explain the output, required preconditions (e.g., active session), or how the tool interacts with the system. The output schema may provide structure, but the description should bridge the gap.

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 coverage is 0%, meaning the input schema has no descriptions for either parameter ('variable' and 'solution'). The description does not explain these parameters at all, failing to compensate for the schema's lack of documentation. The agent has no guidance on what values to provide.

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 verb 'Read' and the resource 'PyAEDT output variable value,' providing a clear purpose. Among sibling tools like 'aedt_get_variables' and 'aedt_create_output_variable,' it distinguishes itself by focusing on reading a specific output variable value, though it could be more explicit about the scope.

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 gives no guidance on when to use this tool versus alternatives. There is no mention of prerequisites, when not to use, or any comparison to similar tools like 'aedt_get_evaluated_value' or 'aedt_get_variables,' leaving the agent without context for selection.

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