List Sales Quotations

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

Annotations already declare readOnlyHint, openWorldHint, and idempotentHint, which align with the read-only 'List' operation. The description adds no additional behavioral context (e.g., result limits, hidden side effects) beyond what annotations provide. No contradictions.

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: first states the core purpose, second lists the supported features. Every word earns its place; no extraneous information.

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 absence of an output schema, the description does not specify what fields are returned or pagination behavior. It mentions OData parameters but does not explain defaults or limits (e.g., top maximum of 1000 is in schema but not description). The tool has many siblings, but the description provides enough to distinguish list vs. get/create/update. Adequate but could be more helpful with output expectations.

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 description mentions 'OData $filter/$top/$skip/$select', adding context that these are standard OData query parameters. The schema only describes the 'filter' parameter with an example. With schema coverage at 25%, the description provides some semantic context but does not elaborate on each parameter's purpose or constraints beyond naming them.

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 'List sales quotation headers' and mentions supported OData operations, distinguishing it from sibling tools like s4_sales_quotation_get (single record) and s4_sales_quotation_create/update (mutations).

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 does not explicitly state when to use this tool over alternatives. It lists OData parameters but provides no context on when to apply them or exclude other list tools. Implicitly, it suggests usage for listing quotations, but lacks guidance on selection criteria among many sibling list tools.

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