get_ticket

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

No annotations provided. The description discloses what the tool returns but does not explicitly state that it is read-only, idempotent, or mention authentication or rate limits. It adequately conveys safe retrieval behavior but lacks explicit behavioral traits.

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 long sentence that lists many return fields. While informative, it could be more structured with bullet points or shorter sentences. It is not verbose but could be better organized.

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?

No output schema exists, but the description compensates by comprehensively listing the returned fields (status, priority, desk, stage, service catalog, etc.) and mentions optional custom fields. This provides sufficient context for understanding the tool's output.

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?

All 3 parameters are described in the schema (100% coverage). The description adds context by explaining that show_entities includes all custom fields and include_filled_entity filters to filled ones, providing meaning beyond the schema's brief descriptions.

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 'Buscar um ticket específico no TiFlux pelo número'—a specific verb and resource. The description differentiates from sibling tools like list_tickets (returns multiple) and get_ticket_files (specific subset), making its purpose unambiguous.

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 when to use (when you need full details of a specific ticket) but does not explicitly state when not to use or suggest alternatives. No direct guidance on choosing among siblings like get_ticket_files or get_ticket_stages_slas.

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