Sync Material Requirements Lines

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

Beyond annotations (readOnly=false, idempotent=true, destructive=false), the description discloses partial-update semantics, the 1000-entity limit with 413 error, defaulting of company_id/project_id from config, error status meanings (401/403/404), and the success return value. This is rich behavioral context that cannot be inferred from the annotations alone.

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 dense but well-structured, front-loading the action and then covering prerequisites, limits, semantics, and error handling. Each sentence provides useful information, though the length is higher than strictly necessary. It could be trimmed slightly, but it remains efficient.

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 core payload for the sync operation is absent from both the schema and description. The tool only accepts path parameters (id, company_id, project_id), yet the description describes syncing lines with ids/origin_ids and item_id/item_origin_id without explaining how those should be supplied. This is a critical gap that prevents correct invocation. No output schema exists either, so the description must compensate, but it doesn't resolve the payload ambiguity.

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 schema covers all three parameters, but the description refers to non-schema fields (ids, origin_ids, item_id, item_origin_id) that are not present in the input schema and are explicitly disallowed by additionalProperties: false. This actively misleads an agent into attempting invalid parameters. While it does add context for the path parameters (defaults, id resolution), the net effect is confusing and inadequate.

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 'Creates or updates material requirements lines', using a specific verb and resource. It distinguishes this from header-level sync (sync_material_requirements_headers appears as a sibling) and provides additional scoping details like the requirement for an existing header.

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 gives clear usage context: prerequisites (material must exist, header must exist), instruction to resolve the parent record with the list tool first, and the 1000-entity limit. However, it does not explicitly name alternative tools or say when NOT to use this tool, so it falls short of a perfect score.

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