Skip to main content
Glama
zackscriven

ghl-mcp-server-v2

by zackscriven

ghl_payment_subscription_list

Read-onlyIdempotent

Retrieve paginated subscription lists filtered by name, status, payment mode, date range, source, contact, or ID. Supports pagination for exploring subscription data.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoSubscription id for filtering of subscriptions.
altIdYesAltId is the unique identifier e.g: location id.
endAtNoClosing interval of subscriptions.
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 subscription for searching.
altTypeYesAltType is the type of identifier.
startAtNoStarting interval of subscriptions.
entityIdNoEntity id for filtering of subscriptions.
contactIdNoContact ID for the subscription
paymentModeNoMode of payment.
entitySourceTypeNoSource of the subscriptions.
getPaymentsCollectedCountNoGet the total payments collected for the subscription.
Behavior4/5

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

Annotations already provide safety profile (read-only, idempotent). The description adds behavioral details such as pagination support, filtering options, OAuth scopes, and endpoint specifics, which go beyond what annotations alone convey.

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 description is somewhat verbose, with repetition of 'List Subscriptions' and a paragraph that could be more concise. However, it is well-structured with front-loaded purpose and includes endpoint details.

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?

Given no output schema, the description covers filtering and pagination but omits return structure, error handling, and default ordering. It is adequate but could provide more detail on what fields are returned and any rate limits.

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 the schema already documents all 13 parameters. The description provides a high-level overview of filtering capabilities but does not add significant new semantic meaning beyond what is in the schema.

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?

The description clearly states 'List Subscriptions' and explains it retrieves a paginated list with filtering. It implicitly distinguishes from the sibling 'get' tool for subscriptions, but does not explicitly differentiate from other list tools in the payment domain.

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 provides context on when to use (for paginated listing with filters) and mentions OAuth scopes and pagination parameters. However, it lacks explicit guidance on when not to use or alternatives (e.g., for a single subscription, use ghl_payment_subscription_get).

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