Skip to main content
Glama

Get observations from a BCB SGS series

get_bcb_series
Read-onlyIdempotent

Retrieve official observations and authoritative schema metadata for an exact BCB SGS dataset ID. Use only after search_official_data identifies the series. Dates, units, periodicity, source, and raw values are preserved; generic access does not guess transformations.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
endNoInclusive end date; defaults to today.
limitNoMaximum number of observations to return.
orderNoObservation order by date.asc
startNoInclusive start date; defaults to three years ago.
dataset_idYesExact BCB dataset ID returned by search_official_data.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesSource-preserving data or schema payload for the selected official dataset.
metaYesResponse metadata and source provenance.
linksNoRelated API links.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of observations to return."
    • addedInput schema / properties / order / description
      Added value: +"Observation order by date."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": {},
      +  "description": "REST-aligned Open Economics response with data, metadata, links, and source provenance.",
      +  "properties": {
      +    "data": {
      +      "description": "Source-preserving data or schema payload for the selected official dataset."
      +    },
      +    "links": {
      +      "additionalProperties": {},
      +      "description": "Related API links.",
      +      "properties": {
      +        "observations": {
      +          "description": "Canonical observations endpoint for this dataset.",
      +          "type": "string"
      +        },
      +        "self": {
      +          "description": "Canonical URL for this response.",
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "meta": {
      +      "additionalProperties": {},
      +      "description": "Response metadata and source provenance.",
      +      "properties": {
      +        "dataset": {
      +          "description": "Open Economics dataset identity when supplied."
      +        },
      +        "provenance": {
      +          "description": "Upstream source URLs, versions, timestamps, and methodology details."
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "data",
      +    "meta"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive behavior, so the safety profile is covered. The description adds genuine behavioral context beyond that: data is returned with dates, units, periodicity, source, and raw values preserved, and no transformations are guessed. This tells the agent what arrives unmodified, which the annotations do not.

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?

Two tight sentences with the purpose front-loaded and the prerequisite in the second sentence. Every clause carries information, though 'authoritative schema metadata' and the closing phrase about not guessing transformations are slightly redundant with adjacent statements.

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?

With an output schema present, rich annotations, and full parameter coverage, the description only needs to supply the prerequisite and fidelity context, which it does. The one remaining gap is disambiguating itself from get_bcb_schema, which it leaves unaddressed.

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 all five parameters (dataset_id, start, end, limit, order) are already documented in the schema, including defaults, patterns, and enum. The description only alludes to dates being preserved and does not add format or usage detail beyond the schema, so the baseline 3 applies.

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

Purpose4/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 ('Retrieve official observations and authoritative schema metadata') for an exact BCB SGS dataset ID, which is concrete. However, the phrase 'and authoritative schema metadata' blurs the line with the sibling get_bcb_schema, and the description never resolves that overlap, so an agent cannot fully separate the two from text alone.

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 an explicit prerequisite and ordering: 'Use only after search_official_data identifies the series,' which clearly sequences this tool behind the search tool. It does not, however, say when to prefer this over get_bcb_schema, which is the closest-looking sibling.

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.