olist_produto_obter_estoque

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

With no annotations provided, the description carries the full burden of behavioral disclosure, but it only repeats the endpoint and links to documentation. It does not mention whether the operation is read-only, what happens if the product is not found, any authentication requirements, or what the response contains.

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, consisting of three short sentences: purpose, endpoint, and documentation link. It is front-loaded and free of unnecessary elaboration, though there is minor redundancy between the name and the endpoint statement.

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?

This is a simple tool with one parameter and no output schema, but the description does not explain what the tool returns (e.g., stock quantity, warehouse breakdown) or how the 'id' should be interpreted. The documentation link provides some external context, but the description alone is incomplete for an agent to fully understand the tool's behavior.

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 coverage is 100% (only 'id' parameter with a clear description), so the schema already documents the parameter fully. The tool description adds no additional meaning beyond what the schema provides, matching the baseline for high coverage.

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 'Obter Estoque Produto' (Get Product Stock) and the exact API endpoint, making the tool's purpose specific and unambiguous. It distinguishes itself from sibling tools like olist_produto_atualizar_estoque (update stock) and olist_produto_obter (get product details).

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 no guidance on when to use this tool versus alternatives such as olist_produto_atualizar_estoque or olist_produtos_pesquisa. It merely states the endpoint and documentation link without any situational context or exclusions.

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