update_ticket

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

Nenhuma anotação fornecida, então a descrição carrega todo o peso. Revela que a API v2 não permite alterar solicitante, que desk_id não suporta transferência via update, que o campo description aceita Markdown e é convertido para HTML, e que responsible_id pode ser null para remover responsável. Esses comportamentos vão além do que está no schema.

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?

A descrição tem seções claras (propósito, heurística, nota) e informações importantes estão no início. É um pouco longa devido aos detalhes, mas cada frase contribui para a clareza. Não é excessivamente prolixa.

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?

A descrição cobre comportamento, parâmetros, limitações e alternativas. A ausência de schema de saída não é compensada por menção ao retorno, mas para uma ferramenta de atualização, isso pode ser inferido. Dados os 13 parâmetros e a complexidade, a descrição é bastante completa.

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?

A cobertura do schema é 100% (todos os parâmetros com descrição), então a linha de base é 3. A descrição adiciona valor extra, como a preferência por desk_name sobre client_id, a conversão automática de Markdown em description, e a busca automática por nome em desk_name, stage_name, catalog_item_name. Isso justifica um 4.

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?

A primeira frase define claramente a ação: 'Atualizar um ticket existente no TiFlux.' O verbo 'atualizar' e o recurso 'ticket' são específicos. Distingue-se de ferramentas irmãs como create_ticket, cancel_ticket e close_ticket.

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?

Fornece orientação explícita sobre quando usar desk_name vs client_id ('heurística mesa-first'), e indica explicitamente uma alternativa (create_ticket) para vincular solicitante, uma vez que a API v2 não permite alterá-lo via update. Também menciona a limitação de transferência de mesa.

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