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

ghl-mcp-server-v2

by zackscriven

ghl_payment_subscription_list

Read-onlyIdempotent

Retrieves a paginated list of subscriptions, filterable by name, status, date range, contact, and other criteria for targeted payment subscription review.

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) Requires a Sub-Account (location) token. OAuth scopes: payments/subscriptions.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_subscription_list"
  }
}

Input 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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds genuinely useful non-schema facts: the HTTP endpoint, the v3 version header, the required Sub-Account (location) token, and the payments/subscriptions.readonly OAuth scope. It does not describe response shape or a maximum page size, but auth and transport context is well covered.

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?

Purpose and filtering are front-loaded, but the closing sentence ("This endpoint provides a straightforward way to explore and retrieve subscription information") is pure filler, and the long filter enumeration duplicates the schema. The endpoint/auth/scope blocks do earn their 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 read-only list tool with no output schema, the description covers the prerequisites an agent actually needs: auth token type, OAuth scope, and pagination mechanics. Missing are return-shape hints and default ordering, which matters somewhat for an unpaginated-by-default listing call.

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 coverage is 100%, so the schema already carries parameter meaning; the description mostly restates it (name, altType, date range, payment mode, contact, entity id). It also advertises a "subscription status" filter that has no corresponding property in the schema, while omitting getPaymentsCollectedCount, so it adds little net semantic value.

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 opens with a specific verb+resource ("retrieve a paginated list of subscriptions") and names the filter surface, so the agent knows exactly what this does. It never explicitly contrasts itself with the sibling ghl_payment_subscription_get, so sibling differentiation rests on the word "list" in the name.

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

Usage Guidelines4/5

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

It gives clear operating context: scope to a sub-account/location token, use the listed filters to narrow results, and use limit/offset to page through full result sets. It stops short of stating when to prefer this over subscription_get or what to do when the result set is empty.

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