Skip to main content
Glama
zackscriven

ghl-mcp-server-v2

by zackscriven

ghl_payment_coupon_get

Read-onlyIdempotent

Retrieve coupon details by ID or promotional code, including usage statistics, validity periods, and parameters.

Instructions

Fetch Coupon The "Get Coupon Details" API enables you to retrieve comprehensive information about a specific coupon using either its unique identifier or promotional code. Use this endpoint to view coupon parameters, usage statistics, validity periods, and other promotional details. Endpoint: GET /payments/coupon (Version header: v3; source: v3/payments-v3.json) OAuth scopes: payments/coupons.readonly

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesCoupon id
codeYesCoupon code
altIdYesLocation Id
altTypeYesAlt Type
Behavior4/5

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

Annotations already provide readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds value by specifying the HTTP method (GET), OAuth scope, and the ability to retrieve by either ID or code. No contradictions.

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

Conciseness5/5

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

The description is concise and front-loaded: it begins with the purpose, lists the API details, and includes scopes. No unnecessary information.

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 retrieval tool without an output schema, the description effectively communicates what the endpoint returns (coupon parameters, usage stats, validity periods). It could briefly mention the response format, but the current level is sufficient.

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 coverage is 100% and the description mentions the two key identifiers (id and code). While the description adds a bit of context on how to use them, the schema already documents all parameters adequately, so the description's added value is minimal.

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 clearly states the tool retrieves comprehensive information about a specific coupon using ID or code. It lists the kind of data returned (parameters, usage stats, validity periods) and distinguishes itself from sibling tools like create/delete/list by being a retrieval endpoint.

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?

The description tells the agent to use this endpoint to view coupon details, which implies it's for individual coupon lookups. However, it does not explicitly contrast with the list tool or state when not to use it, but the context is clear enough.

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/zackscriven/ghl-mcp-server'

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