Skip to main content
Glama
Sign In
WebCake Storefront MCP

WebCake Storefront MCP

by vuluu2k
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

list_promotions

Read-only

Retrieves every storefront promotion and discount in one call, summarizing counts for active and POS-synced offers so you can audit campaigns without fetching each promotion individually.

Instructions

List ALL promotions/discounts of the site (every page is fetched for you). Each row has id, name, type, is_activated, pos_id (non-null = linked/synced with POS), start/end time. The summary answers "how many promotions / how many synced with POS / how many active" in ONE call — do not call get_promotion per row for that. Use get_promotion only for one promotion's full rules.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_promotions"
  }
}

Input Schema

NameRequiredDescriptionDefault
include_guideNoInclude promotion type reference guide

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.36.1
    • removedInput schema / properties / limit
      Removed value: -{
-  "description": "Items per page (default: 20)",
-  "type": "number"
-}
    • removedInput schema / properties / page
      Removed value: -{
-  "description": "Page number (default: 1)",
-  "type": "number"
-}
  2. First observedv1.31.8

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so safety is covered; the description adds genuinely new behavioral context by disclosing automatic pagination ('every page is fetched for you') and that the response includes an aggregate summary answering count questions in one call. It does not cover auth/site-scoping or rate limits, keeping it below a 5.

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?

Four short sentences, front-loaded with the scope and pagination guarantee, then row shape, then the sibling routing. No filler and nothing repeated from the schema.

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

Completeness5/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 by naming the row fields and the summary contents, and it explains pagination handling. An agent has everything needed to call it correctly and interpret the result.

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?

There is a single optional parameter (include_guide) with 100% schema description coverage, so the schema already explains it. The description never mentions include_guide or what the type reference guide contains, so it adds nothing beyond the schema — baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('List ALL promotions/discounts of the site') with explicit scope ('every page is fetched for you') and enumerates the fields each row carries. It also names the sibling it is not (get_promotion), so an agent can distinguish the two without opening either schema.

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

Usage Guidelines5/5

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

Explicitly excludes a misuse path — 'do not call get_promotion per row for that' — and states the condition that selects the alternative: 'Use get_promotion only for one promotion's full rules.' Both when-to-use and when-not-to-use are given.

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