Skip to main content
Glama

smile-io

List earning rules (ways to earn)

smile_list_earning_rules
Read-only

List the enabled earning rules — the ways customers earn points or rewards (placing an order, signing up, birthdays, custom activities), with reward, reward_value, earning_limit and any VIP-tier restriction. Cursor-paginated. Smile: GET /earning_rules.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of results, 1-250 (Smile default 50).
cursorNoCursor from the previous response's metadata.next_cursor (or previous_cursor). Omit for the first page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds genuinely useful behavior beyond that: only *enabled* rules are returned, the response carries reward/reward_value/earning_limit and VIP-tier restrictions, and results are cursor-paginated. This is meaningful added context for a read tool.

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?

Three compact, front-loaded sentences: purpose and explanation first, then returned fields, then pagination and the underlying Smile endpoint. The parenthetical examples of earning types earn their place by making the resource concrete; nothing is wasted, though the field enumeration borders on redundant detail.

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?

With no output schema, the description compensates well by naming the key returned fields (reward, reward_value, earning_limit, VIP-tier restriction) and the pagination model. An agent can call this correctly with just the schema plus description; only the full response shape and permission requirements remain unstated.

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% — both 'limit' (1-250, default 50) and 'cursor' are fully documented in the schema, so the baseline is 3. The description only restates pagination ('Cursor-paginated') without adding format or edge-case detail beyond the schema.

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 the enabled earning rules') and explains what the resource actually is ('the ways customers earn points or rewards'), which is more than a restatement of the name. It does not explicitly differentiate itself from any sibling, though the sibling set is composed of unrelated resources, so confusion risk is low.

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?

Usage is only implied: 'Cursor-paginated' hints at the multi-page retrieval pattern, and 'enabled' implies a filter over the full rule set. There is no explicit when-to-use guidance, no mention of prerequisites (e.g., API credentials), and no named alternative for retrieving disabled rules or a single rule.

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.