voog_ecommerce_api_call

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

Annotations indicate destructiveHint=true and readOnlyHint=false. The description adds that GET is deprecated and that it supports query parameters like ?include= and ?language_code=. It also mentions 'Same shape as voog_admin_api_call' which helps, but lacks explicit details on auth requirements or response structure beyond what annotations hint.

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 with two paragraphs: the first states purpose and usage, the second provides a deprecation warning. No redundant information, and the key points are front-loaded.

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 complex generic passthrough tool, the description covers base URL, sibling differentiation, deprecation, and example endpoints. It does not detail error handling or response format, but given no output schema, it is reasonably 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?

Schema coverage is 100%, so the description's addition of specific query parameters (?include=, ?language_code=) and envelope conventions adds value beyond the schema. However, the schema already adequately describes the parameters and their types.

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 explicitly states it is a generic passthrough to the Voog Ecommerce v1 API, distinguishing it from voog_admin_api_call by noting different base URL. It lists specific use cases like orders, carts, discounts, etc., making the purpose clear and 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?

The description provides clear guidance on when to use this tool (e.g., for orders, carts, etc.) and explicitly tells users to use voog_ecommerce_api_read instead for GET requests, noting deprecation. This gives effective alternatives and context.

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