Skip to main content
Glama

List perks

list_perks
Read-onlyIdempotent

List a brand's perks with how many have been granted, revealed to members and redeemed, and for coupons with a code pool, how many codes are left and how many grants are waiting for one.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "brandId": "<brandId>"
    },
    "name": "list_perks"
  }
}

Input Schema

NameRequiredDescriptionDefault
brandIdYesBrand ID, the project that offers the perk.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

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=false, so the safety profile is fully covered externally. The description's main value-add is disclosing the shape of the result (counts of granted/revealed/redeemed and coupon code-pool status), which matters since there is no output schema. However, it says nothing about pagination, ordering, or what the response looks like when a brand has no perks or no code pool.

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?

One front-loaded sentence with no filler, and the primary resource is stated before the metric detail. It becomes slightly run-on in the trailing coupon/code-pool clause, which could have been tightened into a second sentence.

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-parameter, read-only aggregation tool with full schema coverage and complete annotations, the description covers the essentials: what is listed and what metrics come back. It would be stronger with a note on result ordering or behavior for brands with no perks, but nothing an agent needs to invoke it is missing.

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?

Only one parameter (brandId), and the schema documents it at 100% coverage with a clear description. The phrase "a brand's perks" implicitly ties the call to brandId but adds no syntax, format, or failure semantics beyond the schema. Baseline 3 applies when the schema does the work.

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 (list) and resource (a brand's perks), and goes further by enumerating the aggregate counters returned: granted, revealed, redeemed, plus code-pool remaining codes and pending grants. That is far more informative than the title. It doesn't explicitly contrast with siblings like list_giveaways or list_programs, but the resource boundary is unambiguous.

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 when-to-use guidance, no mention of alternatives, and no prerequisites (e.g., that the brand must exist or that the caller needs a brand-scoped token). Usage is only inferable from the verb and the metric list.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources