Skip to main content
Glama
ghl-mcp-server-v2

ghl-mcp-server-v2

by zackscriven

ghl_payment_order_get

Read-onlyIdempotent

Retrieve details for a single payment order by its unique ID. Fetch order information using the order ID and location token for sub-account access.

Instructions

Get Order by ID The "Get Order by ID" API allows to retrieve information for a specific order using its unique identifier. Use this endpoint to fetch details for a single order based on the provided order ID. Endpoint: GET /payments/orders/{orderId} (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/orders.readonly

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": {
      "orderId": "<orderId>",
      "altId": "<altId>"
    },
    "name": "ghl_payment_order_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
altIdYesAltId is the unique identifier e.g: location id.
orderIdYesID of the order that needs to be returned
locationIdNoLocationId is the id of the sub-account.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description still adds genuinely useful operational context: the required Sub-Account (location) token and the payments/orders.readonly OAuth scope, which govern whether the call will succeed. It stops short of describing error behavior or return shape.

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?

Front-loaded with the core action, then endpoint/version/source, then auth requirements. The opening title plus the first sentence restate the same idea, which is mild redundancy but not damaging.

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

Completeness3/5

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

There is no output schema, so the description is the only place to learn what a fetched order contains, and it says nothing about the response body. Auth, scope and endpoint are covered, but the agent knows nothing about the returned resource's fields.

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%, so orderId, altId and locationId are all documented at the schema level, and the description only restates that a unique order identifier is needed. It does not resolve the confusing overlap between the required altId and optional locationId, which is the main ambiguity an agent would face.

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 (retrieve a single order by unique identifier) and gives the exact endpoint GET /payments/orders/{orderId}. It does not explicitly distinguish itself from sibling ghl_payment_order_list, though 'by ID' vs a list is inferable.

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?

'Use this endpoint to fetch details for a single order based on the provided order ID' implies the usage context (single-record lookup) but names no alternative such as ghl_payment_order_list or ghl_payment_order_list_fulfillments, and states no exclusions or preconditions beyond the token note.

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

Deploy Server

Other Tools