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

ghl-mcp-server-v2

by zackscriven

ghl_payment_transaction_list

Read-onlyIdempotent

Lists payment transactions with pagination and filters for name, status, date range, contact, subscription, and source type, enabling targeted transaction retrieval.

Instructions

List Transactions The "List Transactions" API allows to retrieve a paginated list of transactions. Customize your results by filtering transactions based on name, alt type, transaction status, payment mode, date range, type of source, contact, subscription id, entity id or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve transaction information. Endpoint: GET /payments/transactions (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/transactions.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>",
      "altType": "<altType>"
    },
    "name": "ghl_payment_transaction_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
altIdYesAltId is the unique identifier e.g: location id.
endAtNoClosing interval of transactions.
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 transaction for searching.
altTypeYesAltType is the type of identifier.
startAtNoStarting interval of transactions.
entityIdNoEntity id for filtering of transactions.
contactIdNoContact id for filtering of transactions.
locationIdNoLocationId is the id of the sub-account.
paymentModeNoMode of payment.
subscriptionIdNoSubscription id for filtering of transactions.
entitySourceTypeNoSource of the transactions.
entitySourceSubTypeNoSource sub-type of the transactions.

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 cover the read-only, idempotent, non-destructive profile, and the description adds real context beyond them: a Sub-Account (location) token is required and reading needs the payments/transactions.readonly scope, which matters for auth failures. It also names the endpoint and paging parameters, though it says nothing about result caps or sort order.

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 endpoint, auth and pagination lines are front-loaded and earn their place, but the opening repeats the tool title twice and pads with filler ('provides a straightforward way to explore and retrieve transaction information'). Roughly half the prose is boilerplate.

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 14-parameter read tool with no output schema and no enums, the description covers the essentials: auth scope, required location context, filtering dimensions and pagination. The remaining gap is guidance on the meaning/allowed values of altType/entitySourceType and what a returned transaction record contains.

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 description coverage is 100%, so every parameter is already documented in the schema and the baseline is 3. The description only contributes the paging hint (limit/offset), and it actually mentions a 'transaction status' filter that has no corresponding schema parameter, adding slight confusion rather than clarity.

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 (retrieve/list) and resource (payment transactions) plus scope (paginated, filterable per sub-account location). It is distinguishable from ghl_payment_transaction_get and ghl_payment_order_list by being a filtered collection retrieval, though it never names a sibling to reinforce the boundary.

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?

It enumerates the dimensions you can filter on and notes paging via limit/offset, which implies when the tool is useful. But it gives no explicit when-to-use/when-not guidance versus ghl_payment_transaction_get for single records or the order/subscription list tools.

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