Skip to main content
Glama

Post Sales Loadprogress

hgr_post_sales_loadprogress
Read-onlyIdempotent

Dedicated HGRApi tool for POST api/Sales/LoadProgress. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Reads the auto-ordering progress of one exact order line. ownerAgent: orders-autoordering. Domain: orders. Entity: order_line. Operation: get_progress. Scope: current_store. Use when: Use it to see the auto-ordering states of an existing order line, for example to explain why an automatic purchase failed. Input: [FromBody] rq: LoadProgressRequest. Main fields: Id: int. Header channel: current ChannelOAuthId. Output: Returns states (id, date, status, error, errorMessage), lastStatus, lastStatusUpdate and lastAccountAlias. errorMessage is null for most errors. It is returned for CandBeMarkedAsDisparched errors and for OutOfStock errors whose text starts with No eligible new offer. That text means auto-ordering refused the order because the supplier has no offer in new condition, so nothing was bought; the text after Refused conditions: lists the conditions it found. Search terms: sales loadprogress. Send the exact request payload in body. 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>",
      "channelOAuthId": "<channelOAuthId>"
    },
    "name": "hgr_post_sales_loadprogress"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesHGRApi POST /api/Sales/LoadProgress request body.
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

A4.2/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description adds genuinely new behavioral context: fixed endpoint versus generic caller, internal channel/ChannelOAuthId resolution, and detailed semantics of errorMessage — that it is null for most errors, appears for CandBeMarkedAsDisparched and specific OutOfStock cases, and that the trailing text lists the refused conditions.

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 lead sentence is front-loaded and identifies the endpoint, but the definition is padded with boilerplate ("This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller"), a trailing "Search terms" fragment, and a long errorMessage digression whose value could be conveyed in half the space.

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

Completeness5/5

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

Given an output schema already exists, the description needn't enumerate return fields yet still summarizes them, and it covers the remaining unknowns an agent needs: authentication channel handling, exact body submission, and the one error case where errorMessage carries actionable diagnostic text.

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?

Schema coverage is 100%, so baseline is 3, but the description adds real meaning: the body is a LoadProgressRequest with a main int field Id, and the payload must be sent exactly as the request body. Note a mild tension — the schema requires a channelOAuthId parameter while the description says the header channel is "resolved internally."

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 and resource: "Reads the auto-ordering progress of one exact order line," plus domain/entity/operation metadata (orders / order_line / get_progress). The scope qualifier "one exact order line" implicitly separates it from the order-level hgr_load_order_progress sibling, but that sibling is never named, so an agent must infer the distinction.

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?

"Use when: ...to see the auto-ordering states of an existing order line, for example to explain why an automatic purchase failed" gives a concrete trigger scenario. It stops short of explicit exclusions or pointing at alternatives such as hgr_load_order_progress or hgr_search_orders when the target is an order rather than a line.

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