List Potential Change Order Line Items

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

Annotations indicate read-only, idempotent, non-destructive, which align with a list operation. However, the internal contradiction between 'Potential Change Order Line Items' and 'Change Orders' undermines transparency about what is returned. Additionally, no description of the response structure beyond pagination metadata.

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?

Contains several sentences but includes misleading information (returns Change Orders) and redundant references to the API endpoint that are already implied. Could be more concise by removing the inconsistent statement and focusing on the line item context.

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 9 parameters and no output schema, the description should clarify the return structure. It inaccurately describes the return type as 'Change Orders' and omits details about the line item fields. The filtering and pagination hints are useful but insufficient to fully understand the tool's output.

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 does not need to elaborate on parameters. It mentions required parameters but adds no additional semantic meaning beyond the schema. Baseline 3 is appropriate given full schema 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 starts by stating it returns a list of Potential Change Order Line Items, but later contradicts by saying 'Returns a paginated JSON array of Change Orders.' This inconsistency muddles the purpose and could confuse an AI agent about what the tool actually returns.

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?

Provides explicit usage: 'Use this to enumerate Change Orders when you need a paginated overview, to find IDs, or to filter by query parameters.' Also links to filtering documentation. However, it does not mention when not to use it among sibling change order listing tools, such as when you need commitment or prime change order line items.

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