Skip to main content
Glama

reference-data

get_snapshot

Read-onlyIdempotent

PAID ($0.02). Snapshot of every series for every country in one call. Pass api_key if you have one (instant card checkout at /pricing); otherwise the response explains how to pay via x402. Every US series is free to try. After a 200, bind get_changes (free poll) or register_alert (HMAC push; Register: $0 · Delivery after trial: $0.05) on this series so a later gazette does not silently retire the value.

Input Schema

NameRequiredDescriptionDefault
api_keyNoAPI key

Output Schema

NameRequiredDescriptionDefault
errorNoPresent on a free refusal or error; no charge
resultNoOne entry per country; every series value carries confidence_label, coverage_label and label_basis
countriesNo
no_chargeNo
price_usdNo
disclaimerNo
how_to_payNo
bind_seriesNo
explanationNo
x_next_bindNo
http_endpointNo
payment_requiredNotrue when the call needs payment; how_to_pay explains x402 or card

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • removedOutput schema / properties / result / items / properties / series / items / properties / label_basis / properties / source_type / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / series / items / properties / label_basis / properties / source_type / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / items / properties / series / items / properties / label_basis / properties / verification_age_days / anyOf
      Removed value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / series / items / properties / label_basis / properties / verification_age_days / type
      Added value: +[
      +  "number",
      +  "null"
      +]
  2. Changed1 schema field changed
    • addedOutput schema / properties / result
      Added value: +{
      +  "description": "One entry per country; every series value carries confidence_label, coverage_label and label_basis",
      +  "items": {
      +    "additionalProperties": {},
      +    "properties": {
      +      "country": {
      +        "type": "string"
      +      },
      +      "series": {
      +        "items": {
      +          "additionalProperties": {},
      +          "properties": {
      +            "confidence": {},
      +            "confidence_label": {
      +              "description": "Evidence verdict derived from source type, verification age and the stale flag (answers: the weakest series read). Rules at /label-rules",
      +              "enum": [
      +                "high",
      +                "medium",
      +                "low"
      +              ],
      +              "type": "string"
      +            },
      +            "country": {
      +              "type": "string"
      +            },
      +            "coverage_label": {
      +              "description": "How much of the question is covered: ready = complete; partial = held with a disclosed limitation or default; gap = no number served. Rules at /label-rules",
      +              "enum": [
      +                "ready",
      +                "partial",
      +                "gap"
      +              ],
      +              "type": "string"
      +            },
      +            "effective_from": {},
      +            "label_basis": {
      +              "additionalProperties": {},
      +              "description": "Inputs and the rule ids that produced the two labels",
      +              "properties": {
      +                "confidence_reasons": {
      +                  "items": {
      +                    "type": "string"
      +                  },
      +                  "type": "array"
      +                },
      +                "coverage_reasons": {
      +                  "items": {
      +                    "type": "string"
      +                  },
      +                  "type": "array"
      +                },
      +                "inputs": {
      +                  "items": {},
      +                  "type": "array"
      +                },
      +                "rules": {
      +                  "type": "string"
      +                },
      +                "rules_version": {
      +                  "type": "string"
      +                },
      +                "source_type": {
      +                  "anyOf": [
      +                    {
      +                      "type": "string"
      +                    },
      +                    {
      +                      "type": "null"
      +                    }
      +                  ]
      +                },
      +                "stale": {
      +                  "type": "boolean"
      +                },
      +                "verification_age_days": {
      +                  "anyOf": [
      +                    {
      +                      "type": "number"
      +                    },
      +                    {
      +                      "type": "null"
      +                    }
      +                  ]
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "last_confirmed": {},
      +            "notes": {},
      +            "series": {
      +              "type": "string"
      +            },
      +            "source": {},
      +            "stale": {
      +              "type": "boolean"
      +            },
      +            "unit": {},
      +            "value": {}
      +          },
      +          "type": "object"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
  3. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "description": "Every series for every country of this brand",
      +  "properties": {
      +    "bind_series": {},
      +    "countries": {},
      +    "disclaimer": {},
      +    "error": {
      +      "description": "Present on a free refusal or error; no charge"
      +    },
      +    "explanation": {},
      +    "how_to_pay": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "http_endpoint": {
      +      "type": "string"
      +    },
      +    "no_charge": {
      +      "type": "boolean"
      +    },
      +    "payment_required": {
      +      "description": "true when the call needs payment; how_to_pay explains x402 or card",
      +      "type": "boolean"
      +    },
      +    "price_usd": {
      +      "type": "number"
      +    },
      +    "x_next_bind": {}
      +  },
      +  "type": "object"
      +}
  4. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Annotations cover the safety profile (readOnly, idempotent, openWorld, non-destructive), and the description layers on the genuinely non-inferable operational facts: a $0.02 cost, two payment paths depending on whether you hold an api_key, and a free US-series trial. This is exactly the auth/cost context the structured fields cannot express.

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?

Front-loads the most decision-relevant fact (price) and keeps the payment/auth mechanics tight. The trailing sentence about binding get_changes/register_alert is dense and slightly tangential, but each sentence carries operational information rather than filler.

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?

An output schema exists, so return values need no exposition, and the description covers cost, auth, and the failure-path response. Missing only explicit guidance on when this bulk snapshot beats the narrower sibling tools, which for a single-parameter read tool is a minor gap.

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% (baseline 3), but the description adds real meaning to the sole optional parameter: supplying api_key vs omitting it changes the response into a payment instruction via /pricing or x402. That conditional behavior is not captured by the schema's bare 'API key' string.

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 with an explicit scope: 'Snapshot of every series for every country in one call.' The 'every series ... in one call' framing implicitly distinguishes it from the per-series siblings (get_series, get_series_history) without needing to name them.

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?

Gives real invocation context — optional api_key, x402 fallback, free US trial, downstream binding of get_changes/register_alert — but never says when to choose this over get_series or list_series, and get_changes/register_alert are described as follow-ups rather than alternatives. Usage is implied rather than delineated.

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