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

ghl-mcp-server-v2

by zackscriven

ghl_payment_coupon_list

Read-onlyIdempotent

Retrieves all coupons available in a GoHighLevel location, with pagination, search, and status filters to view promotional offers and discounts.

Instructions

List Coupons The "List Coupons" API allows you to retrieve a list of all coupons available in your location. Use this endpoint to view all promotional offers and special discounts for your customers. Endpoint: GET /payments/coupon/list (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/coupons.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_coupon_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
altIdYesLocation Id
limitNoMaximum number of coupons to return
offsetNoNumber of coupons to skip for pagination
searchNoSearch term to filter coupons by name or code
statusNoFilter coupons by status
altTypeYesAlt Type

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, openWorld), so the bar is lower, yet the description still adds real context: a Sub-Account (location) token is required and the OAuth scope payments/coupons.readonly is named. It does not describe result shape or whether paging past the end errors, but the auth/scope disclosure is genuinely 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.

Conciseness3/5

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

The purpose is front-loaded, but the second sentence ("view all promotional offers and special discounts for your customers") restates the first without adding information. The endpoint/version/source line is metadata noise for an agent choosing a tool, so the text is longer than it needs to be.

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 list tool with no output schema, the description supplies the essentials an agent needs to call it correctly: auth requirement, scope, endpoint version, and pagination. It does not state what fields come back or whether filtering combines (search AND status), which is the main residual gap.

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 every parameter including search, status enum, and altId is already documented with examples and defaults. The description only restates that limit and offset are pagination params, adding no semantics beyond the schema, 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 gives a specific verb and resource ("retrieve a list of all coupons available in your location") and scopes it to a location, which separates it from the coupon create/update/delete siblings whose names make their purpose obvious. It does not explicitly contrast against ghl_payment_coupon_get, but the list-vs-single distinction is clear enough from the wording.

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?

"Use this endpoint to view all promotional offers and special discounts" implies the browsing use case but gives no when-not conditions or explicit alternatives. The only concrete guidance is the pagination note ("pass them to page through full result sets"), which is useful but narrow.

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