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 BR 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.7/5.0
Behavior5/5

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

Beyond the annotations, it discloses that the tool is paid ($0.02), how authentication/payment works, that BR series are free to try, and how to persist the snapshot via get_changes or register_alert. These are material behavioral details not present in the structured annotations.

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 paid cost and snapshot scope, and most sentences carry useful invocation context. However, it includes some sibling-specific pricing detail ('Register: $0 · Delivery after trial: $0.05') and marketing phrasing that is not essential for selecting or invoking get_snapshot.

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?

Given the output schema exists and annotations cover read-only/idempotent/openWorld behavior, the description supplies the remaining critical context: cost, auth/payment path, bulk scope, and recommended follow-up tools. Nothing essential for calling the tool correctly appears to be missing.

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

Parameters5/5

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

The only parameter is api_key, and the schema already describes it at 100% coverage. The description adds useful conditional semantics: pass it if you have one, otherwise the response explains x402 payment, which meaningfully clarifies the parameter beyond the schema's 'API key' label.

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 capability and scope: 'Snapshot of every series for every country in one call.' This clearly distinguishes it from narrower siblings such as get_series and get_series_history, which do not promise a full multi-country bulk snapshot.

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 gives clear payment/auth context and follow-up choices: pass api_key if available, otherwise follow the x402 payment instructions, then bind get_changes or register_alert after a 200. It does not explicitly state when to choose get_snapshot instead of a narrower series endpoint, so an important alternative-selection guideline is missing.

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