Skip to main content
Glama
AIWerk

@aiwerk/mcp-server-ghl

by AIWerk

payments_delete_coupon

DestructiveIdempotent

Delete a coupon by ID from GoHighLevel payments to remove outdated or unused discount codes, keeping your pricing accurate.

Instructions

Delete Coupon

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesCoupon Id
altIdNoLocation Id Defaults to GHL_LOCATION_ID when omitted.
altTypeNoAlt Type Defaults to GHL_LOCATION_ID when omitted.
Behavior2/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true, and idempotentHint=true, covering the safety profile. The description adds no context beyond the literal 'Delete Coupon', such as irreversibility, impact on associated data, or permission requirements. It neither contradicts nor enriches 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.

Conciseness2/5

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

At two words, the description is undeniably concise, but it suffers from under-specification rather than effective brevity. It lacks any structural guidance or explanatory context, making it more of a label than a useful description.

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

Completeness2/5

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

For a destructive operation with no output schema, the description is incomplete. It does not mention what happens after deletion, whether the action is reversible, or any failure modes. Even though the tool is simple, the lack of side-effect context makes it insufficient for an agent to fully anticipate the behavior.

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% (all three parameters have descriptions), so the schema fully documents parameter meaning. The description itself provides no additional parameter semantics, which matches the baseline for full schema coverage.

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 'Delete Coupon' clearly states a specific verb (Delete) and resource (Coupon), unambiguously distinguishing it from sibling tools like payments_create_coupon, payments_get_coupon, and payments_update_coupon. Although terse, the purpose is immediately understandable.

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 deletion tool versus related tools such as payments_update_coupon or payments_list_coupons. There is no mention of prerequisites, side effects, or scenarios where deletion is appropriate, leaving the agent to infer usage from the operation type alone.

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