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

ghl-mcp-server-v2

by zackscriven

ghl_payment_order_list

Read-onlyIdempotent

Retrieve paginated payment orders and filter them by status, payment mode, contact, source, funnel product, or date range to find specific transactions.

Instructions

List Orders The "List Orders" API allows to retrieve a paginated list of orders. Customize your results by filtering orders based on name, alt type, order status, payment mode, date range, type of source, contact, funnel products or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve order information. Endpoint: GET /payments/orders (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/orders.readonly Pagination params: limit, offset — pass them to page through full result sets.

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

Input Schema

NameRequiredDescriptionDefault
altIdYesAltId is the unique identifier e.g: location id.
endAtNoClosing interval of orders.
limitNoThe maximum number of items to be included in a single page of results
offsetNoThe starting index of the page, indicating the position from which the results should be retrieved.
searchNoThe name of the order for searching.
statusNoOrder status.
startAtNoStarting interval of orders.
sourceIdNoSource id
contactIdNoContact id for filtering of orders.
locationIdNoLocationId is the id of the sub-account.
paymentModeNoMode of payment.
paymentStatusNoPayment Status of the Order
funnelProductIdsNoFunnel product ids separated by comma.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so the safety profile is covered. The description adds genuinely non-schema context: the required Sub-Account (location) token, the payments/orders.readonly OAuth scope, the v3 version header, and that limit/offset page through full result sets. It does not describe the shape of returned order objects, which is the remaining gap.

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?

The endpoint, auth, scope and pagination facts are front-loaded and each carries operational value. The closing sentence ('This endpoint provides a straightforward way to explore and retrieve order information') is marketing filler that could be cut, but the bulk of the text 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?

For a 13-parameter list tool with annotations and no output schema, the description supplies the operation, filters, pagination mechanics, auth requirement and required scope — enough to call it correctly. It stops short of characterizing the returned order records, which is the only meaningful omission.

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?

With 100% schema description coverage the schema already documents all 13 parameters, so the baseline of 3 applies. The description groups the filters into categories (name, alt type, status, payment mode, date range, source, contact, funnel products) and explains that limit/offset are the pagination pair, adding organization but no new per-parameter meaning such as formats or valid status values.

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

Purpose5/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 ('retrieve a paginated list of orders') and enumerates the filter dimensions, which clearly separates it from ghl_payment_order_get and the other payment siblings. The endpoint line (GET /payments/orders, v3) further pins down exactly what is being called.

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?

Usage is implied rather than prescribed: it says to 'customize your results by filtering' and offers a 'straightforward way to explore and retrieve order information,' which suggests exploratory/listing use. There is no explicit when-not guidance or named alternative (e.g. ghl_payment_order_get for a single order, ghl_payment_transaction_list for transactions), so the agent must infer the routing.

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