excluir_venda

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

No annotations are provided, so the description must fully disclose behavioral traits. It only states 'Excluir' (delete), but lacks critical details such as whether this is a soft or hard delete, if there are cascading effects on related data, permission requirements, or undo options. The absence of such information leaves the agent uncertain about the operation's impact.

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 plus a bullet-point prerequisite. Every word adds value, with the main action stated in the first sentence and the prerequisite in the second. There is no redundancy or unnecessary detail, making it easy to scan quickly.

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 the tool's simplicity (one parameter, no output schema) and the absence of annotations, the description provides the minimal information needed: what it does and a prerequisite. However, the lack of behavioral transparency (e.g., irreversibility) and parameter details leaves the description incomplete for an agent to invoke it confidently without guessing about side effects.

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 schema has one required parameter (id_venda) with 0% description coverage. The description does not add meaning beyond the parameter name; it only mentions 'ID do pedido' in the prerequisite but does not specify format, constraints, or how to construct it. The tool's sole parameter is self-explanatory from context, but the description fails to provide additional clarity.

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 deletes an order/sale from Ploomes CRM ('Excluir um pedido/venda do Ploomes CRM.'). It uses a specific verb and resource, and while there are sibling tools for deleting other entities (e.g., excluir_negocio, excluir_proposta), the description uniquely identifies its target as 'venda' (sale), making it well-differentiated.

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 an explicit prerequisite: 'Busque o ID do pedido a ser excluido usando buscar_vendas.' This tells the agent to first retrieve the ID using a specific sibling tool, which is helpful for correct tool selection. However, it does not include when not to use this tool or mention any alternative deletion pathways.

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