Skip to main content
Glama

Get merchant order

get_merchant_order
Read-only

Fetch a merchant order by ID to inspect order status, total versus paid amount, items, and attached payments. Use it when a webhook arrives with topic=merchant_order.

Instructions

Fetch a merchant order by ID: order_status, total vs paid amount, items, and every payment attached to it. Useful when a webhook arrives with topic=merchant_order.

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": {
      "merchant_order_id": "<merchant_order_id>"
    },
    "name": "get_merchant_order"
  }
}

Input Schema

NameRequiredDescriptionDefault
merchant_order_idYesMerchant order ID (numeric, as string or number)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered without prose. The description adds useful behavioral detail by enumerating the response payload, but says nothing about what happens on an unknown ID, whether this hits a live external API (despite openWorldHint), or any rate/auth constraints.

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

Conciseness5/5

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

Two tight sentences with no filler: the first states the operation and its return contents, the second states the motivating situation. The most actionable information (what is fetched and by what key) is front-loaded.

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?

With one required parameter, no output schema, and read-only annotations, this definition covers nearly everything an agent needs, and listing the returned fields compensates for the absent output schema. The only meaningful gap is failure behavior for a missing or invalid order ID.

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 coverage is 100% for the single merchant_order_id parameter, including the numeric-string-or-integer union and its constraints, so the schema does the heavy lifting. The description's "by ID" adds no format or syntax detail beyond that, which is the expected baseline when the schema is fully documented.

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?

"Fetch a merchant order by ID" gives a specific verb and resource, and the description enumerates what comes back (order_status, total vs paid amount, items, attached payments), which tells an agent what this tool is for. It does not explicitly contrast itself with the sibling get_payment, so the agent must infer the boundary between order-level and payment-level retrieval.

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 description supplies a concrete trigger condition: "Useful when a webhook arrives with topic=merchant_order," which is real when-to-use guidance tied to a workflow. It stops short of exclusions or naming alternatives (e.g., use get_payment when you already have a payment ID), so it is clear context without routing rules.

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