Skip to main content
Glama

PayPing: list coupons

payping_list_coupons
Read-onlyIdempotent

List discount coupons with code, type, amount, active status, and applicable products. Filter by search text, paginate results, and include archived coupons when needed.

Instructions

List discount coupons: name, type (0 = percent, 1 = Toman), amount, code, active, products it applies to.

Input Schema

NameRequiredDescriptionDefault
limitNoItems to return, 1-50.
offsetNoSkip this many items (paging).
searchNoText to search for.
include_archivedNoInclude archived items.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.2.0
    • removedInput schema / properties / include_archived / title
      Removed value: -"Include Archived"
    • changedInput schema / properties / limit / description
      Previous value: -"Items to return, 1-50 (PayPing's maximum is 50)."New value: +"Items to return, 1-50."
    • removedInput schema / properties / limit / title
      Removed value: -"Limit"
    • removedInput schema / properties / offset / title
      Removed value: -"Offset"
    • removedInput schema / properties / search / title
      Removed value: -"Search"
    • removedInput schema / title
      Removed value: -"payping_list_couponsArguments"
    • changedOutput schema / (root)
      Previous value: -{
      -  "additionalProperties": true,
      -  "title": "payping_list_couponsDictOutput",
      -  "type": "object"
      -}New value: +null
  2. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is fully covered without the description. The description adds a useful data-model detail (coupon type encoding 0=percent, 1=Toman) but says nothing about pagination behaviour or whether archived coupons appear by default.

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?

A single front-loaded sentence with no filler; the resource and its key fields come first. It is appropriately sized, though the parenthetical field list is a slight run-on.

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

Completeness3/5

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

With no output schema, the description's enumeration of returned fields is genuinely useful. However, for a paged, searchable list tool it omits how paging/search behave and omits any hint about result volume, leaving the agent to reconstruct that from the schema alone.

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 limit, offset, search, and include_archived are already fully documented in the schema and the baseline is 3. The description's 'type' detail refers to a returned field, not any input parameter, so it adds no parameter meaning.

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?

States a clear verb+resource ('List discount coupons') and even enumerates the returned fields, which helps an agent know what data it gets. It does not, however, distinguish itself from the sibling payping_get_coupon (single-coupon fetch), so an agent choosing between list and get gets no explicit signal.

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?

There is no statement of when to use this tool, no mention of the singular payping_get_coupon alternative, and no indication that the listing can be paged or filtered. Usage must be inferred entirely from the name and schema.

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