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

ghl-mcp-server-v2

by zackscriven

ghl_payment_subscription_get

Read-onlyIdempotent

Retrieve a specific subscription's details by subscription ID and location identifier. Fetch single subscription information for payment lookups.

Instructions

Get Subscription by ID The "Get Subscription by ID" API allows to retrieve information for a specific subscription using its unique identifier. Use this endpoint to fetch details for a single subscription based on the provided subscription ID. Endpoint: GET /payments/subscriptions/{subscriptionId} (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/subscriptions.readonly

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": {
      "subscriptionId": "<subscriptionId>",
      "altId": "<altId>",
      "altType": "<altType>"
    },
    "name": "ghl_payment_subscription_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
altIdYesAltId is the unique identifier e.g: location id.
altTypeYesAltType is the type of identifier.
subscriptionIdYesID of the subscription that needs to be returned

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover readOnly, idempotent, openWorld and destructive hints, so the safety profile is set. The description adds genuinely useful context beyond them: the required Sub-Account (location) token and the payments/subscriptions.readonly OAuth scope. It does not describe the return payload, but the annotation coverage makes that less critical.

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 purpose comes first, followed by endpoint metadata and auth requirements. The opening repeats the title phrasing ('Get Subscription by ID... allows to retrieve information'), a minor redundancy, but otherwise it is tight.

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 3-parameter read with no output schema, the description supplies the endpoint, API version, auth token type, and OAuth scope, which is enough for an agent to invoke it correctly. Return-value shape is left to the API, which is acceptable.

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 all three parameters (subscriptionId, altId, altType) are already documented with examples and the enum. The description adds only that retrieval is keyed on the subscription ID, restating what the schema provides, so baseline 3 applies.

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 states a specific verb and resource ('retrieve information for a specific subscription using its unique identifier'), making the single-item fetch clear. It does not explicitly name ghl_payment_subscription_list as the alternative, but the singular scope distinguishes it adequately.

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 provides clear context ('fetch details for a single subscription based on the provided subscription ID'), which implicitly routes the agent away from the list tool. There are no explicit exclusions or prerequisites beyond that.

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