aedt_create_report

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

The description carries the full burden since no annotations are provided. It only says 'create a report' but does not disclose side effects (e.g., whether it modifies the project, requires a solved design, or is destructive). Behavioral traits like error conditions or session needs are absent.

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 9-word sentence, which is concise but severely under-specified. It front-loads the purpose but omits all necessary details. Every word earns its place, but the description is incomplete.

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 complexity (7 parameters, presence of output schema), the description is woefully incomplete. It does not explain what the output schema contains, what the parameters mean, or what constitutes a valid report. The agent lacks critical context to invoke the tool 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?

Schema description coverage is 0%, yet the description provides no information about the 7 parameters (e.g., expressions, report_category, setup_name). The agent must rely solely on the schema, which lacks descriptions. The description adds no value beyond the tool name.

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 (create) and resource (AEDT report) with method (through PyAEDT post-processing). It is distinguishable from siblings like aedt_create_touchstone_report which is more specific. However, it does not specify the type of report or differentiate from other reporting tools.

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 instead of alternatives such as aedt_export_report or aedt_get_solution_data. There is no mention of prerequisites, context, or conditions for appropriate usage.

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