salvar_familia_produto

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

No annotations present. Description does not disclose side effects, required permissions, or whether the operation is idempotent. For a mutation tool, this is insufficient behavioral transparency.

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?

Two concise sentences with no fluff. Front-loaded with the purpose. Every word earns its place.

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 (2 params, no output schema), the description covers basic create/update logic. Missing return value description and error handling, but adequate for a straightforward operation.

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 has 0% description coverage. Description explains that id is for updating an existing family, but nome is not described. Only partial value added for one of two parameters.

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?

Description clearly states 'create or update a product family in Ploomes CRM', specifying the action and resource. Differentiates from sibling tools like buscar_familias_produto (search) and excluir_familia_produto (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?

Provides basic guidance: pass ID to update, omit to create. However, lacks explicit when-not-to-use or alternatives (e.g., for products, use salvar_produto instead). No mention of prerequisites or typical workflow.

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