clm_timeline_command_generate_equipment_timeline_excel_report

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

The description adds useful behavioral context by disclosing that the request is asynchronous and returns immediately without waiting for generation. It does not contradict the destructiveHint annotation, though the annotation seems surprising for a report-generation tool; it also does not explain how or where the finished report will be delivered.

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 that front-loads the main action and resource before listing filters. It is reasonably concise with no filler, though the long filter enumeration makes it slightly dense.

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 large number of parameters and the asynchronous pattern, the description is a minimal viable explanation but not complete. It omits how the agent should retrieve the generated report, whether a FileId must be supplied, and what the immediate response contains; the presence of an output schema mitigates this gap only partially.

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%, and the description only conceptually mentions filters for site, status, date range, team/equipment ids, and search keys. Many parameters such as FileId, Language, PageSize, Ascending, PageNumber, OrderByField, HasIncidentAnnotation, and HasDocumentationAnnotation are left completely unexplained.

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 'queues', the resource 'Excel export of the site-equipment timeline', and the asynchronous nature of the operation. It also distinguishes this from the sibling generate_up_timeline_excel_report by specifying 'site-equipment' rather than 'up'.

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 implies this should be used when an Excel export of an equipment timeline is needed, and it lists the available filters. However, it does not explicitly say when to use this tool versus the similar sibling generate_up_timeline_excel_report or the list_equipment_timeline read tool.

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