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

ghl-mcp-server-v2

by zackscriven

ghl_payment_coupon_get

Read-onlyIdempotent

Retrieve coupon details by ID or promotional code to view usage statistics, validity periods, and other payment promotion data for a location.

Instructions

Fetch Coupon The "Get Coupon Details" API enables you to retrieve comprehensive information about a specific coupon using either its unique identifier or promotional code. Use this endpoint to view coupon parameters, usage statistics, validity periods, and other promotional details. Endpoint: GET /payments/coupon (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/coupons.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": {
      "altId": "<altId>",
      "altType": "<altType>",
      "id": "<id>",
      "code": "<code>"
    },
    "name": "ghl_payment_coupon_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesCoupon id
codeYesCoupon code
altIdYesLocation Id
altTypeYesAlt Type

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the description is not carrying the safety burden. It adds genuinely useful operational context beyond the annotations: required Sub-Account (location) token, OAuth scope payments/coupons.readonly, HTTP verb and v3 version header.

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?

Purpose and usage come first and the whole thing is three compact chunks. The parenthetical '(source: v3/payments-v3.json)' is internal provenance noise, and quoting the API name 'Get Coupon Details' duplicates the title without adding meaning.

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 read-only single-resource fetch with full schema coverage and no output schema, the description supplies auth, scope and return categories, which is enough to call it correctly. The only real gap is the unresolved id-vs-code lookup rule, which matters because all four params are marked required.

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% (id, code, altId='Location Id', altType enum), so the schema does the heavy lifting and baseline 3 applies. The description's claim that lookup works via 'either its unique identifier or promotional code' conflicts with a schema that marks all four fields required, an ambiguity an agent could trip over; it also never explains why altType is needed.

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?

States a specific verb and resource ('retrieve comprehensive information about a specific coupon') and enumerates what is returned (parameters, usage statistics, validity periods). The word 'specific' plus the id/code lookup keys clearly distinguish it from the sibling ghl_payment_coupon_list, create, update and delete tools.

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?

'Use this endpoint to view coupon parameters, usage statistics, validity periods' gives a clear context for invocation, and the Sub-Account token note flags the prerequisite. It never names a when-not condition or points to the list sibling for browsing, so it stops short of full routing guidance.

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