salvar_usuario

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

No annotations are provided, so the description must convey behavioral traits. It only mentions 'create or update' but omits details on side effects (e.g., what happens to omitted fields), required permissions, or rate limits. This is insufficient for a write operation.

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 concise and well-structured: main purpose, update condition, and a list of observações. Each sentence serves a purpose, though a brief note on optional fields could improve it without adding much length.

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?

With 8 parameters, no output schema, and no annotations, the description should provide more context on parameter behavior, return values, and error scenarios. The current description only covers the basic workflow and prerequisites, leaving significant gaps for an AI agent to invoke correctly.

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%. The description only references three parameters (id, perfil_id, cargo_id) through observações but does not explain the meaning or constraints of other parameters like nome, email, facebook, linkedin, or telefone. The schema alone does not provide enough context.

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 user in Ploomes CRM, with a specific instruction on using ID for updates. This distinguishes it from siblings like salvar_cliente or salvar_produto, which target different entities.

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 explicitly lists three sibling tools (buscar_usuarios, buscar_perfis_usuario, buscar_cargos_de_clientes) needed to obtain required IDs, providing clear guidance on prerequisites and when to use alternative tools.

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