Skip to main content
Glama

Yappman Data Supermarket Price Snapshots

Shelf-price index over several weeks

get_index_series
Read-onlyIdempotent

Returns the UK or Australian online shelf-price index over time, oldest week first, up to 26 weeks: level, week-on-week and four-week change, matched counts. Headline rows unless recordType says otherwise: retailer and class narrow other kinds, e.g. recordType class. Posted online shelf prices, not prices paid; not a CPI. Levels are not price levels and do not show which retailer is cheaper. list_index_vintages gives the weeks held. Product-level rows are not served: see about_the_data.

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": {
      "market": "<market>"
    },
    "name": "get_index_series"
  }
}

Input Schema

NameRequiredDescriptionDefault
classNoOnly rows for this product class id, e.g. "dairy-eggs"; needs a recordType that has class rows, e.g. "class".
marketYesuk or au. Example: "uk".
retailerNoOnly rows for this retailer id, e.g. "tesco" (UK) or "aldi_au" (AU); needs a recordType that has retailer rows, e.g. "retailer".
toVintageNoLast ISO week, e.g. "2026-W45". Omit for the latest published week.
recordTypeNoKind of row, e.g. "class". Omit for "headline".
fromVintageNoFirst ISO week, e.g. "2026-W42". Omit for up to 26 weeks ending at toVintage.

Output Schema

NameRequiredDescriptionDefault
asOfYes
baseYes
notesYes
titleNo
creditYes
marketYes
notCpiYes
seriesYes
toVintageNo
weeksHeldYes
recordTypeYes
fromVintageNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the annotations, the description discloses important behavior: rows are ordered oldest-first, the series is capped at 26 weeks, headline rows are the default, and retailer/class filters depend on recordType. It also adds critical interpretation caveats, including that these are posted shelf prices, not paid prices or CPI, and that levels do not indicate which retailer is cheaper.

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?

The description is front-loaded with the core return behavior and then gives filters and caveats in a compact sequence. It is dense and somewhat long, but nearly every sentence is necessary for correct interpretation and selection.

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?

For a six-parameter read-only tool with a full input schema and an output schema, the description covers scope, ordering, maximum range, default row type, filter interactions, available-week discovery, unsupported product-level rows, and interpretation limits. Nothing material appears missing for correct invocation or interpretation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the underlying parameter documentation already carries much of the burden. The description still adds meaningful semantics beyond the schema by clarifying the default headline record type and explaining how retailer and class parameters interact with recordType.

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?

The description states a specific verb and resource: it returns the UK or Australian online shelf-price index over time, oldest week first, up to 26 weeks. It also names the returned measures and distinguishes this time-series tool from week-listing and product-level alternatives.

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

Usage Guidelines4/5

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

It explains the default record type, how retailer and class filters narrow results, that list_index_vintages provides available weeks, and that product-level rows are not served, directing the agent to about_the_data. It does not explicitly compare against every sibling such as get_shelf_price_index, but the intended usage is clear.

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