get_order_edit

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

No annotations are provided, so the description must carry the behavioral disclosure burden. It only states 'Fetch an order edit by ID' and does not reveal any details about error handling, authentication, rate limits, or the structure of the returned order edit. This is minimal disclosure beyond the obvious read operation.

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 a single sentence that is immediately clear and front-loaded with the action and resource. There is no redundant or irrelevant text, making it highly concise.

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?

While the tool is simple with one parameter and no output schema, the description lacks essential context about what an 'order edit' is, especially given the presence of related order-edit tools in the sibling list. It also doesn't specify what the response contains. This incompleteness could lead to incorrect usage.

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 100% of the parameter documentation, including a descriptive example ('gid://shopify/OrderEdit/123456789'). The tool description adds no additional parameter semantics beyond what the schema already provides, so the baseline score of 3 is appropriate.

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 'Fetch an order edit by ID' uses a specific verb ('Fetch') and resource ('order edit') with a clear scope (by ID). It distinguishes itself from siblings like get_order, calculate_order_edit, and apply_order_edit, which target different resources or actions.

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 no when-to-use guidance or comparison to alternatives. Given related tools like calculate_order_edit and apply_order_edit, some context on when to retrieve an order edit directly would help. Without this, the agent has no explicit direction.

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