salvar_documento

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

No annotations are provided, so the description must carry the full burden of behavioral disclosure. It clarifies create/update behavior but does not mention side effects, permissions, rate limits, or return values. The mutation nature is implied but not elaborated.

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 with a clear main sentence followed by bullet-point observations. It is front-loaded with the primary purpose and uses minimal wording. Every sentence adds value.

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 12 parameters, no output schema, and no annotations, the description is insufficient. It fails to explain the return value, behavior on success/failure, or provide context for most parameters. The tool is moderately complex, but the description only partially addresses the gaps.

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 the description must add meaning. It explains the semantics of ID (create vs update), contato_id (from buscar_clientes), template_id (from buscar_templates_documentos), and the format for campos_customizados. However, it ignores other parameters (valor, titulo, etc.), leaving them unexplained.

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 document/contract in Ploomes CRM, with the distinction of passing an ID for updates. This distinguishes it from sibling tools like buscar_documentos (list/search) and excluir_documento (delete).

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 provides three observations that guide prerequisite usage: obtaining ContactId from buscar_clientes, TemplateId from buscar_templates_documentos, and the format for campos_customizados. It implicitly covers when to create vs update (via presence of ID). However, it does not explicitly mention when to use this tool versus reading or deleting documents.

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