Skip to main content
Glama

get_vouchers

Read-onlyIdempotent

Retrieve a paginated list of all vouchers, including active and inactive codes, to manage discounts, monitor validity, and track remaining uses.

Instructions

Overview

Get a paginated list of all vouchers in your system, including active and inactive vouchers with their current status.

When to Use

  • Voucher management - View all vouchers in your admin panel

  • Inventory overview - See all available discount codes

  • Status monitoring - Check which vouchers are active

  • Reporting - Generate lists of all vouchers for analysis

What You Get

  • Complete voucher list - All vouchers with full details

  • Discount information - Type, value, and currency for each voucher

  • Validity status - Start/end dates and current status

  • Usage tracking - Remaining uses for each voucher

Pagination

Results are paginated. Use the page and limit query parameters to navigate through the list, e.g. /vouchers?page=5&limit=10.

Quick Start

Optionally provide page and limit query parameters. Returns a paginated list of vouchers with complete details including codes, discounts, validity, and usage counts.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number to retrieve (1-based).
limitNoNumber of vouchers to return per page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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, idempotentHint, openWorldHint, and destructiveHint=false, so the read-only safety profile is fully covered by structured data. The description adds pagination behavior via page/limit and enumerates returned fields, which is genuinely useful, but it adds no permission requirements, rate limits, or default page size.

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?

The description is heavily padded with four markdown sections that repeat the same idea (list of vouchers with details) multiple times; 'What You Get' and 'Quick Start' restate the Overview. Front-loaded, but several bullets such as 'Inventory overview - See all available discount codes' earn no place.

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 reasonably carries the burden of describing return contents (codes, discounts, validity, usage counts) and pagination. But it omits practical details an agent needs — default page size, how to detect the last page, whether a total count is returned — leaving the listing behavior underspecified.

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% for both parameters and the schema already documents page (1-based) and limit (per page). The description's example `/vouchers?page=5&limit=10` adds a little concreteness but no semantics beyond the schema, and both params are optional with no stated defaults.

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 states a specific verb and resource — listing all vouchers with active/inactive status — so the agent knows it retrieves a collection. However, it never distinguishes itself from close siblings like get_vouchers_voucherid (single voucher) or get_vouchers_history, which an agent must infer from the name alone.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The 'When to Use' section provides context (voucher management, inventory overview, reporting), but these bullets are largely restatements of 'you want to list vouchers' rather than discriminating conditions. No alternative tool is named and no exclusion (e.g., use get_vouchers_voucherid for one voucher) is offered.

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

Deploy Server

Other Tools