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

ghl-mcp-server-v2

by zackscriven

ghl_payment_coupon_delete

DestructiveIdempotent

Permanently deletes a coupon by ID so checkout links using its code stop applying discounts. Use it to discontinue promotions or clean up unused coupons; this action cannot be undone.

Instructions

Permanently deletes the coupon. Any checkout links relying on its code will stop applying the discount. Delete Coupon The "Delete Coupon" API allows you to permanently remove a coupon from your system using its unique identifier. Use this endpoint to discontinue promotional offers or clean up unused coupons. Note that this action cannot be undone. Endpoint: DELETE /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_delete"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.0
    • addedInput schema / properties / body / title
      Added value: +"DeleteCouponParams"
  2. First observedv2.0.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true and openWorldHint=true, so the bar is lower, yet the description still adds real context: checkout links relying on the coupon code will stop applying the discount, the action is irreversible, and a Sub-Account (location) token with payments/coupons.write scope is required. It does not cover what the API returns or whether deletion is blocked when the coupon is attached to active orders.

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 impact on checkout links is correctly front-loaded, but permanence is asserted three times ('Permanently deletes', 'permanently remove a coupon', 'this action cannot be undone'), and the OpenAPI provenance line ('Version header: v3; source: v3/payments-v3.json') is noise for an agent. Roughly a third of the text is repeated or irrelevant.

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 single-parameter destructive endpoint with full annotation coverage, no output schema, and 100% schema description coverage, the description supplies the missing pieces: downstream business impact, auth/scope requirement, and irreversibility. Only edge-case behavior (deletion when the coupon is referenced by live checkout links) is left unstated.

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 baseline is 3. The description adds a small amount of meaning by framing 'its unique identifier' as the coupon id and clarifying that the altId is a Sub-Account/location token, but it does not explain the altId/altType pairing or the body wrapper beyond what the schema shows.

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 opening sentence states a specific verb and resource ('Permanently deletes the coupon') and immediately scopes it by noting the downstream effect on checkout links. Against siblings like ghl_payment_coupon_get/update/list, the destructive intent is unmistakable from the first sentence.

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 discontinue promotional offers or clean up unused coupons' gives concrete usage situations, which is more than most delete tools offer. It does not name an alternative (e.g., updating a coupon's active status instead of deleting it) or state preconditions for refusal, so it falls short of a full when/when-not treatment.

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