pr_update

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

Sem anotações, a descrição precisa carregar o comportamento. Ela revela que se trata de uma operação de escrita que exige confirmação ('Escrita: write + confirm') e delimita o que a ferramenta não faz. Isso adiciona contexto além do schema, embora não detalhe efeitos colaterais ou permissões.

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?

Duas frases curtas e diretas, com a ação principal e as restrições apresentadas no início. Não há redundância ou conteúdo desnecessário.

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 é suficiente para o uso básico, mas não há output schema e a ferramenta tem 8 parâmetros. Faltam detalhes sobre o retorno da operação, validações de confirmação e como o agente deve lidar com o campo confirm obrigatório. Ainda assim, o essencial para uma chamada simples está presente.

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?

Com cobertura de schema de apenas 38%, a descrição ajuda ao mapear os campos editáveis (título, descrição, rascunho, branch), mas não explica parâmetros obrigatórios como repo e prId nem aprofunda o papel de confirm. O schema já documenta target, isDraft e project, então a descrição cobre parcialmente a lacuna.

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 descrição usa o verbo 'Edita' com o recurso PR e especifica os campos afetados (título, descrição, rascunho, branch de destino). Diferencia-se de operações de status ao afirmar explicitamente que abandonar e mergear não passam pela ferramenta.

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?

A frase 'NÃO altera status: abandonar e mergear não passam por aqui' estabelece uma condição clara de quando não usar a ferramenta. Não nomeia alternativas específicas, como pr_create ou pr_add_reviewers, mas o escopo de uso fica bem delimitado.

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