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

ghl-mcp-server-v2

by zackscriven

ghl_payment_coupon_create

Creates promotional coupons with configurable discount amounts, validity dates, usage limits, and product or price restrictions for GoHighLevel payments.

Instructions

Create Coupon The "Create Coupon" API allows you to create a new promotional coupon with customizable parameters such as discount amount, validity period, usage limits, and applicable products. Use this endpoint to set up promotional offers and special discounts for your customers. Endpoint: POST /payments/coupon (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/coupons.write

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": {
      "body": "<body>"
    },
    "name": "ghl_payment_coupon_create"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • changedInput schema / properties / body / properties / applyToFuturePaymentsConfig / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "duration": {
      -        "description": "Duration the coupon to be applied in a subscription",
      -        "example": 5,
      -        "type": "number"
      -      },
      -      "durationType": {
      -        "description": "Type of the duration",
      -        "enum": [
      -          "months"
      -        ],
      -        "example": "months",
      -        "type": "string"
      -      },
      -      "type": {
      -        "description": "Type of the config",
      -        "enum": [
      -          "forever",
      -          "fixed"
      -        ],
      -        "example": "forever | fixed",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "duration",
      -      "durationType"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "duration": {
      +        "description": "Duration the coupon to be applied in a subscription",
      +        "example": 5,
      +        "type": "number"
      +      },
      +      "durationType": {
      +        "description": "Type of the duration",
      +        "enum": [
      +          "months"
      +        ],
      +        "example": "months",
      +        "type": "string"
      +      },
      +      "type": {
      +        "description": "Type of the config",
      +        "enum": [
      +          "forever",
      +          "fixed"
      +        ],
      +        "example": "forever | fixed",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "duration",
      +      "durationType"
      +    ],
      +    "title": "ApplyToFuturePaymentsConfig",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"CreateCouponParams"
  2. 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 the safety profile (readOnlyHint false, idempotentHint false, destructiveHint false, openWorldHint true). The description adds meaningful operational context: the endpoint, v3 version header, requirement for a Sub-Account location token, and OAuth scope. It does not describe duplicate-code handling or response behavior, but it is consistent with annotations and richer than them.

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 description is front-loaded with purpose and includes compact operational details such as endpoint, token requirement, and OAuth scope. It has some redundancy, repeating the title and restating that it creates a coupon, but overall it is appropriately sized for a nested create operation.

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?

Given the rich input schema and annotations, the description covers the key invocation context: endpoint, authentication, required token type, and OAuth scope. It does not explain the response shape, but the agent has enough information to invoke the tool correctly.

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 nested body fields are already well documented. The description only summarizes parameter categories like discount amount, validity period, usage limits, and applicable products, adding little beyond the schema's field-level descriptions.

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?

The description states a specific verb and resource: creating a new promotional coupon. It explains the customizable parameters and use for promotional offers, clearly distinguishing this create operation from sibling coupon list/get/update/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 Guidelines3/5

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

It gives a general use case: setting up promotional offers and special discounts for customers. However, it does not state when to use this versus related coupon tools, nor does it provide exclusions or prerequisites beyond the token requirement.

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