olist_produto_alterar

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

The description highlights that the operation mutates data ('altera dados') and requires 'confirmar=true', which is a key behavioral trait. Since no annotations are present, the description carries the burden, but it only adds this minimal disclosure; it doesn't detail consequences, permission requirements, or reversibility.

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 relatively short and front-loaded with 'Alterar Produto'. However, it includes an endpoint identifier and a documentation link that may not be immediately useful for an AI agent, slightly reducing efficiency.

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?

The tool has a nested 'produto' object with no defined properties in the schema, requiring external knowledge of the layout. The description provides a documentation link but does not explain how to identify which product to update or the expected data structure. Given the moderate complexity, the description is only partially complete.

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 covers both parameters (produto and confirmar) with descriptions, achieving 100% coverage. The tool description adds no extra parameter meaning beyond the already-present requirement for confirmar=true, so the baseline of 3 applies.

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 states 'Alterar Produto' (Change Product) and 'Esta operação altera dados', clearly indicating an update operation for a product. The verb 'alterar' and resource 'produto' are specific, and the name differentiates it from sibling alteration tools for other entities. However, it doesn't specify which product fields can be changed, so it's not fully specific.

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?

No guidance is provided on when to use this tool versus alternatives. The description only states the operation changes data and requires confirmation, without mentioning prerequisites, excluded cases, or comparison with related tools like olist_produto_incluir or olist_produto_obter.

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