Skip to main content
Glama
AIWerk

@aiwerk/mcp-server-ghl

by AIWerk

payments_list_transactions

Read-onlyIdempotent

Retrieve transactions from GoHighLevel payments with filters for contact, subscription, date range, and payment mode.

Instructions

List Transactions

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. Defaults to GHL_LOCATION_ID when omitted.
paymentModeNoMode of payment.
subscriptionIdNoSubscription id for filtering of transactions.
entitySourceTypeNoSource of the transactions.
entitySourceSubTypeNoSource sub-type of the transactions.
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. However, the description adds no additional behavioral context—no mention of pagination (limit/offset), filtering capabilities, or what a successful response contains. It provides zero value beyond the annotations.

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

Conciseness2/5

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

The description is extremely short—two words—and while it contains no fluff, it is under-specified rather than concise. It lacks structure, front-loading of key constraints (like required params), and any instructional content. It reads like a placeholder rather than a deliberate summary.

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

Completeness2/5

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

With 14 parameters and 2 required, the description offers no explanation of the required altId/altType, no mention of pagination semantics, and no guidance on filters like search or paymentMode. There is no output schema, and the description doesn't clarify the return shape. An agent would find the schema alone insufficient for correct invocation.

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 each parameter already has a terse description. The tool description 'List Transactions' adds no extra meaning to the parameters, meeting the baseline for full schema coverage. No further elaboration is provided.

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?

Description 'List Transactions' clearly states the verb (List) and resource (Transactions), and distinguishes it from single-record tools like payments_get_transaction_by_id. It could be more specific about scoping (e.g., by altId), but the basic purpose is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus alternatives like payments_list_orders, payments_list_subscriptions, or payments_get_transaction_by_id. The required parameters altId/altType are not explained in the description, leaving the agent to infer usage from the schema alone.

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/AIWerk/mcp-server-ghl'

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