Skip to main content
Glama
zackscriven

ghl-mcp-server-v2

by zackscriven

ghl_payment_transaction_list

Read-onlyIdempotent

Retrieve a paginated list of transactions with filters by name, type, status, payment mode, date range, source, contact, subscription, or entity. Use limit and offset to paginate results.

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) OAuth scopes: payments/transactions.readonly Pagination params: limit, offset — pass them to page through full result sets.

Input Schema

TableJSON 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.
Behavior4/5

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

Annotations declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, confirming safe read behavior. The description adds value beyond annotations by explaining pagination (limit, offset), filtering capabilities, and OAuth scopes, which inform the agent of important behavioral aspects.

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 description is front-loaded with the core purpose and contains four sentences. It includes technical details like endpoint and OAuth scopes which, while not strictly necessary, add context without excessive verbosity. Slightly less concise than ideal but well-structured.

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?

The tool has many parameters and no output schema. The description covers filtering and pagination adequately but omits details on response structure, sorting, or total count. Given the complexity and absence of output schema, more completeness would be beneficial.

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?

Input schema has 100% description coverage, providing baseline value. The description adds semantic grouping of filter options (name, alt type, date range, etc.) and explicitly mentions pagination parameters, helping the agent understand which filters are available and how to page results.

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 clearly states it retrieves a paginated list of transactions with filtering options. The verb 'List' matches the resource 'Transactions', distinguishing it from sibling tools like `ghl_payment_transaction_get` (single transaction) and `ghl_payment_subscription_list`.

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?

The description explains what the tool does but provides no explicit guidance on when to use it versus other list tools (e.g., `ghl_payment_order_list`). Usage context is implied through the resource name, but no exclusion or alternative recommendations are given.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/zackscriven/ghl-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server