Skip to main content
Glama
AIWerk

@aiwerk/mcp-server-ghl

by AIWerk

payments_update_coupon

Idempotent

Update existing coupon details like discount value, type, dates, and usage limits in GoHighLevel payments. Modify coupon properties to keep promotions accurate and current.

Instructions

Update Coupon

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesCoupon Id
codeYesCoupon Code
nameYesCoupon Name
altIdNoLocation Id Defaults to GHL_LOCATION_ID when omitted.
altTypeNoAlt Type Defaults to GHL_LOCATION_ID when omitted.
endDateNoEnd date in YYYY-MM-DDTHH:mm:ssZ format
startDateYesStart date in YYYY-MM-DDTHH:mm:ssZ format
productIdsNoProduct Ids
usageLimitNoMax number of times coupon can be used
discountTypeYesDiscount Type
discountValueYesDiscount Value
limitPerCustomerNoLimits whether a coupon can be redeemed only once per customer.
applyToFuturePaymentsNoIs Coupon applicable on upcoming subscription transactions
applyToFuturePaymentsConfigNoIf coupon is applicable on upcoming subscription transactions, how many months should it be applicable for a subscription
Behavior2/5

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

Annotations indicate readOnlyHint=false, openWorldHint=true, idempotentHint=true, and destructiveHint=false. The description does not add any behavioral context beyond the name, such as what gets mutated, authentication needs, or side effects. Given the annotations present, the description contributes minimal additional transparency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

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

The description is extremely concise at two words, but it is under-specified rather than efficiently structured. It omits critical information that an agent would need, making the brevity a deficiency rather than a benefit.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With 14 parameters, including nested objects and no output schema, the description is grossly incomplete. It provides no information about required fields, behavior, return values, or usage context, making it nearly useless for an agent attempting to call 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?

The input schema has 100% description coverage for all 14 parameters, so the schema fully documents parameter meaning. The description itself provides no parameter information, which is acceptable since the schema carries the weight. Baseline of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Update Coupon' clearly identifies the verb (update) and resource (coupon), which distinguishes it from other tools like payments_create_coupon. However, it lacks any specifics about what can be updated or any additional context, so it is only minimally useful beyond the tool name itself.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives like payments_create_coupon or payments_delete_coupon. It does not state prerequisites, context, or when this update is appropriate, leaving the agent without direction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/AIWerk/mcp-server-ghl'

If you have feedback or need assistance with the MCP directory API, please join our Discord server