Skip to main content
Glama

Post Sales Markasdispatched

hgr_post_sales_markasdispatched
Destructive

Dedicated HGRApi tool for POST api/Sales/MarkAsDispatched. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Acknowledges in HGR that an order-dispatch warning was handled manually for one exact order line. ownerAgent: orders-autoordering. Domain: orders. Entity: order_line. Operation: acknowledge_manual_dispatch. Scope: current_store. Use when: Use only when the user explicitly wants to clear the HGR warning after manually handling dispatch in the marketplace. Input: [FromBody] rq: AddAutoOrderReferenceRequest. Main field: OrderLineId: int. Required Header channel: current ChannelOAuthId. Output: Marks the dispatch warning as acknowledged in HGR and returns whether the order line was updated. Search terms: sales markasdispatched. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "body": "<body>",
      "confirmed": "<confirmed>",
      "channelOAuthId": "<channelOAuthId>"
    },
    "name": "hgr_post_sales_markasdispatched"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesHGRApi POST /api/Sales/MarkAsDispatched request body.
confirmedYesMust be true after the user explicitly requested or confirmed the exact action.
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.9/5.0
Behavior4/5

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

Beyond annotations (which already mark it destructive and non-idempotent), the description discloses that confirmed=true is required before execution and that the tool returns whether the order line was updated. It does not elaborate on side effects or reversibility beyond the stated acknowledgment purpose, but adds useful safety context.

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

Conciseness3/5

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

The description is front-loaded with the purpose and usage, but includes metadata labels (ownerAgent, Domain, Entity, Operation, Scope) and a search-terms line that add length without helping an agent decide or invoke. Structurally clear, but not every sentence earns its place.

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?

Given an output schema exists, the description is largely complete: it covers purpose, usage condition, confirmation requirement, body type/main field, channel header, and return behavior. The main remaining gap is that the body schema itself does not enumerate fields beyond the main one, but the description points to the key field needed.

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

Parameters4/5

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

With 100% schema coverage the baseline is 3, but the description adds meaning by naming the body type ([FromBody] AddAutoOrderReferenceRequest) and its main field OrderLineId: int, which the schema does not. It also clarifies that channelOAuthId is the required header channel value.

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?

The description states a specific verb and resource: it 'acknowledges in HGR that an order-dispatch warning was handled manually for one exact order line' via POST api/Sales/MarkAsDispatched. It clearly distinguishes itself from a generic endpoint caller, but does not explicitly name or contrast with close siblings such as hgr_post_sales_manuallydispatchorderline.

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

Usage Guidelines4/5

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

The 'Use when' clause is explicit: 'Use only when the user explicitly wants to clear the HGR warning after manually handling dispatch in the marketplace.' It also specifies the confirmed=true precondition. It stops short of naming when-not-to-use cases or alternatives, so it falls short of a 5.

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