Skip to main content
Glama

PayPing: list coupons

payping_list_coupons
Read-onlyIdempotent

List PayPing discount coupons with paging and text search, returning code, discount type, amount, active status, and applicable products.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoItems to return, 1-50 (PayPing's maximum is 50).
offsetNoSkip this many items (paging).
searchNoText to search for.
include_archivedNoInclude archived items.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds the type-code semantics (0 = percent, 1 = Toman), which is genuine value beyond the annotations, but says nothing about paging behavior or result ordering.

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?

A single front-loaded sentence that enumerates the meaningful fields with zero filler. Nothing could be removed without losing information.

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 an output schema present, the field enumeration is somewhat redundant, and the annotations already carry the read-only profile. The definition is adequate for a simple list call but adds little beyond what structured fields already provide.

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% with all four parameters (limit, offset, search, include_archived) fully documented in the schema, including the 1-50 cap. The description adds no parameter detail beyond that, so baseline 3 applies.

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 specific verb and resource ('List discount coupons') and enumerates the returned fields, so the agent knows exactly what this yields. It distinguishes itself from the singular payping_get_coupon and payping_create_coupon siblings implicitly via 'list', but never names them explicitly.

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 when-to-use guidance and no mention of alternatives such as payping_get_coupon for a single coupon or payping_create_coupon for writes. The agent must infer usage from the verb alone.

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