totvs_ticket_comentarios

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive, so the main safety profile is covered. The description adds that results include attachments and sort order behavior but does not mention pagination or limits despite the 'page' parameter, leaving some behavioral gaps.

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, compact paragraph that front-loads the main purpose. Backticks for parameters aid readability. It is efficient but lacks explicit structure like bullet points.

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 presence of an output schema and annotations, the description does not need to cover return values or safety. However, it misses the 'page' parameter and does not explain pagination behavior. For a simple list tool, the description is nearly complete but has a clear 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?

With 0% schema description coverage, the description must compensate. It explains 'ticket_id' as the ticket number and 'sort_order' as DESC/ASC with examples, but it omits the 'page' parameter entirely. This partial coverage is adequate for core usage but incomplete.

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 tool retrieves comments/status updates of a ticket with attachments. It uses specific verbs ('Comentarios/andamentos') and resource ('ticket'), and it distinguishes from siblings like totvs_ticket_detalhe that likely provide ticket details instead of comments.

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 explains the meaning of 'ticket_id' and 'sort_order' but does not provide explicit guidance on when to use this tool versus alternatives like totvs_ticket_detalhe or totvs_tickets_filtrar. No when-not-to-use or context for selecting among siblings is given.

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