Skip to main content
Glama
AIWerk

@aiwerk/mcp-server-ghl

by AIWerk

payments_list_coupons

Read-onlyIdempotent

Get a paginated list of payment coupons, filterable by status, name, or code, with location support.

Instructions

List Coupons

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
altIdNoLocation Id Defaults to GHL_LOCATION_ID when omitted.
limitNoMaximum number of coupons to return
offsetNoNumber of coupons to skip for pagination
searchNoSearch term to filter coupons by name or code
statusNoFilter coupons by status
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=true, idempotentHint=true, destructiveHint=false, covering safety. The description adds no behavioral detail beyond the literal action—it doesn't mention pagination, default limits, ordering, or response format, which are not covered by annotations.

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 extremely concise—two words with no fluff. It is front-loaded and to the point, though arguably too sparse to convey the tool's full capability, it does not waste any words.

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?

Given the tool has six parameters and no output schema, the description is incomplete. It does not explain what the response contains, pagination behavior, or any default settings. An agent relying on this description alone would not know whether the tool returns all coupons or requires filters.

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 schema provides 100% coverage with descriptions for all six parameters, so the baseline is 3. The description 'List Coupons' adds no extra meaning or context about how parameters interact (e.g., how limit/offset control pagination).

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 'List Coupons' uses a specific verb (List) and resource (Coupons), clearly indicating a read operation that returns multiple coupons. It differentiates from siblings like payments_get_coupon (singular) and payments_create_coupon, though it does not explicitly name them.

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 such as payments_get_coupon for retrieving a single coupon, or when to apply filters like status or search. The context is implicit from the tool name but not stated.

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