excluir_documento

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

No annotations are provided, so the description must fully disclose behavior. It only states that the tool excludes (deletes) a document, but fails to mention irreversibility, required permissions, or any side effects of deletion.

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 extremely concise: two sentences with no wasted words. The purpose is front-loaded, and the prerequisite is clearly stated in a separate line.

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?

For a simple one-parameter destructive tool, the description covers the basic purpose and a prerequisite. However, it lacks behavioral details like irreversibility and does not explain the return value (no output schema). It is minimally adequate but not comprehensive.

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?

The input schema has one parameter (id_documento) with no description (0% coverage). The description adds context by instructing to obtain the ID from buscar_documentos, but does not explain the parameter's format, constraints, or expected usage beyond that.

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's purpose: 'Excluir um documento/contrato do Ploomes CRM' (Delete a document/contract from Ploomes CRM). It uses a specific verb and resource, differentiating it from sibling deletion tools like excluir_cliente or excluir_negocio.

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 includes a prerequisite: first get the document ID using buscar_documentos. This guides the agent on the correct usage workflow. However, it does not specify when not to use this tool or mention alternative approaches.

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