reference-data

list_series

Read-onlyIdempotent

FREE. Catalog of all usaref reference-data series: supported countries, series ids, descriptions, freshness metadata and per-series URLs. Call this first to discover what data exists. Paid answer tools accept receipt=true (included in the answer price, no extra USDC) and, on a paid success, return an Ed25519 answer receipt (kind answer_receipt). That receipt is not a series certified extract and is not legal advice. Series certified extracts are GET /v1/certified/{country}/{series} at $0.10 and are not an MCP tool. Verify a receipt with verify_answer_receipt (free, public key only) against /certified/public-key. get_changes is free. get_calendar is free. register_alert registration is free.

Input Schema

Name	Required	Description	Default
`detail`	No	Default false. Without country, false returns a compact index (country -> series ids). true returns the full catalog, which is large.
`country`	No	Optional ISO country code. Returns full per-series metadata (source, freshness, bands) for that country only.

Output Schema

Name	Required	Description
`note`	No
`error`	No	Present on a free refusal or error; no charge
`countries`	No	Country entries ({country, name, series}); on an unknown-country refusal, the list of valid codes
`no_charge`	No
`price_usd`	No
`disclaimer`	No
`how_to_pay`	No
`bind_series`	No
`explanation`	No
`x_next_bind`	No
`http_endpoint`	No
`payment_required`	No	true when the call needs payment; how_to_pay explains x402 or card

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedOct 13, 2026

changedOutput schema / description

Previous value: -"Catalog: brand metadata plus countries[] (compact: country, name, series ids; with country or detail: full per-series metadata)"New value: +"Catalog: brand metadata plus countries[] (compact: country, name, series ids; with country or detail: full per-series metadata including confidence_label and coverage_label)"

Changed1 schema field changedOct 12, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": {},
+  "description": "Catalog: brand metadata plus countries[] (compact: country, name, series ids; with country or detail: full per-series metadata)",
+  "properties": {
+    "bind_series": {},
+    "countries": {
+      "description": "Country entries ({country, name, series}); on an unknown-country refusal, the list of valid codes",
+      "items": {},
+      "type": "array"
+    },
+    "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"
+    },
+    "note": {
+      "type": "string"
+    },
+    "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"
+}

Changed2 schema fields changedOct 12, 2026

addedInput schema / properties / country

Added value: +{
+  "description": "Optional ISO country code. Returns full per-series metadata (source, freshness, bands) for that country only.",
+  "type": "string"
+}

addedInput schema / properties / detail

Added value: +{
+  "description": "Default false. Without country, false returns a compact index (country -> series ids). true returns the full catalog, which is large.",
+  "type": "boolean"
+}

First observedJul 20, 2026

TDQS

A3.7/5.0

Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds that the call is FREE and what metadata is returned, which is genuinely useful, but most of the remaining text discusses paid answer receipts, certified extracts and verification of OTHER tools rather than the behavior of this one.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The first two sentences are well front-loaded and on-topic, but the remainder is off-topic filler about receipt semantics, certified-extract pricing, public-key verification, and a list of which sibling tools are free. Those sentences do not earn their place in a catalog-listing tool's description.

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 not be described, and annotations cover the safety profile. Purpose and discovery sequencing are complete; the only gap is that the noise about other tools slightly dilutes rather than fills anything an agent needs.

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%, so both 'detail' and 'country' are already fully documented in the schema, including the compact-vs-full index distinction and the ISO country code. The description adds nothing about parameters, so the 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 ('Catalog of all usaref reference-data series') and enumerates the payload (countries, series ids, descriptions, freshness metadata, URLs). The imperative 'Call this first to discover what data exists' cleanly separates it from data-fetching siblings like get_series and get_series_history.

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?

'Call this first to discover what data exists' gives clear, actionable when-to-use guidance for a discovery tool. It stops short of explicitly naming the alternative it feeds into (get_series), so the agent must infer the follow-up step, but the sequencing is unambiguous.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All reference-data tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?