List Material BOM headers

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

Annotations already indicate read-only, open-world, and idempotent behavior. Description adds OData support details but doesn't mention any additional behavioral traits (e.g., pagination limits beyond schema-defined max, ordering).

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 purpose, second lists supported OData parameters. No unnecessary words.

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?

Adequate for a simple list tool with no output schema. Purpose, OData support, and annotations cover essential context. Could mention typical use (e.g., retrieving headers for a material) but not required.

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 description coverage is 25% (only filter has description). Description adds context that parameters are OData operators, but doesn't detail top max, skip semantics, or select syntax. Provides a filter example but incomplete.

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?

Clearly states 'List Material Bill of Material headers' with specific verb and resource. Distinguished from sibling tools like s4_material_bom_get (single) and s4_material_bom_create/update.

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?

Mentions OData $filter/$top/$skip/$select support, implying how to query, but lacks explicit guidance on when to use vs alternatives (e.g., comparing to s4_material_bom_get). No exclusion criteria provided.

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