Skip to main content
Glama

Stop Order Lines

hgr_stop_order_lines
Destructive

Stops orders resolved from visible order Reference. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.

Input Schema

NameRequiredDescriptionDefault
confirmedYesMust be true after the user explicitly requested or confirmed the exact action.
referenceNoVisible marketplace/order reference.
channelOAuthIdYesChannelOAuthId returned by hgr_list_channels for the selected visible store.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=false, and openWorldHint=true, so the safety profile is carried structurally. The description usefully adds the explicit-confirmation gate, but does not explain what stopping actually does to the order line or whether it is reversible.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences with the core action and precondition front-loaded and no filler. The final sentence about the HGRApi header channel is terse to the point of being cryptic.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values needn't be described, and annotations cover safety and idempotency. What remains thin is the effect of the stop operation itself and the contradictory framing of channelOAuthId as both required and internally resolved.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all three parameters are already documented; the description only restates 'confirmed=true' and references the visible order reference. The phrase 'ChannelOAuthId resolved internally' is confusing given channelOAuthId is a required parameter, adding ambiguity rather than clarity.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('Stops') and resource ('orders resolved from visible order Reference'), which is enough to separate it from process/force-process siblings. It does not explicitly name the closest alternative (hgr_post_sales_stoporderline, hgr_process_order_lines), so it stops short of full sibling differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives a precondition ('Requires confirmed=true') but no usage context such as when to stop versus process/force-process an order line, or what state the order line must be in. Guidance is implied rather than stated.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources