salvar_checklist_etapa

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

No annotations provided, so description carries full burden. It discloses non-obvious behaviors: automatic field creation as 'Texto multilinha' if field doesn't exist, and texto_informativo as tooltip. However, it doesn't mention whether updating overwrites existing data or permissions needed, but overall provides significant behavioral context.

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?

Description is well-organized with numbered notes, front-loading the purpose. Each sentence adds value, though the notes are slightly verbose. Structure is clear and easy to parse.

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 5 params, no output schema, and no annotations, the description explains the behavior well but omits return value information (e.g., does it return the checklist ID or object?). Also missing error scenario guidance, making it somewhat incomplete for an agent to fully anticipate outcomes.

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%, so description compensates. It explains etapa_id (use buscar_etapas_negocio), id (update), nomes_campos (list, auto-creates field), and texto_informativo (tooltip). However, 'nome' parameter is required but not explained in description, leaving a gap.

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 creates or updates a pipeline stage checklist in Ploomes CRM, using specific verb+resource. It distinguishes from sibling tools like excluir_checklist_etapa (delete) and buscar_checklists_etapa (search) by specifying the create/update behavior.

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?

Explicit guidance: 'Passe o ID para atualizar um checklist existente' indicates when to update vs create. It also references sibling tools (buscar_etapas_negocio for etapa_id, buscar_checklists_etapa for checklist ID) and explains the purpose of nomes_campos and texto_informativo, providing clear when-to-use context.

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