Skip to main content
Glama

Get Series

get_series
Read-onlyIdempotent

Fetch any economic time series by ID (e.g., "CPUR0000SA0" for CPI, "LNS14000000" for unemployment). Returns historical data points with dates and values.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
_apiKeyNoOptional BLS registration key (free, raises the daily cap from ~25 to 500). The gateway supplies a platform key; pass your own only to override.
end_yearNoEnd year as 4-digit string (e.g. "2024"). Optional.
series_idYesBLS series ID (e.g. "CUUR0000SA0" for CPI)
start_yearNoStart year as 4-digit string (e.g. "2020"). Optional.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesTime series data points
totalYesNumber of data points returned. Equal to `returned` — BLS returns every point in the requested year range.
end_yearYesEnd year filter if provided, null otherwise
returnedNoHow many data points are in `data`. Always equal to `total` here; stated so a caller need not assume it.
series_idYesBLS series ID requested
start_yearYesStart year filter if provided, null otherwise
observation_orderNoOrder of the `data` array. BLS returns each series newest-first.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed3 schema fields changed
    • addedOutput schema / properties / observation_order
      Added value: +{
      +  "description": "Order of the `data` array. BLS returns each series newest-first.",
      +  "enum": [
      +    "newest_first"
      +  ],
      +  "type": "string"
      +}
    • addedOutput schema / properties / returned
      Added value: +{
      +  "description": "How many data points are in `data`. Always equal to `total` here; stated so a caller need not assume it.",
      +  "type": "integer"
      +}
    • changedOutput schema / properties / total / description
      Previous value: -"Total number of data points returned"New value: +"Number of data points returned. Equal to `returned` — BLS returns every point in the requested year range."
  2. Changed1 schema field changed
    • addedInput schema / properties / _apiKey
      Added value: +{
      +  "description": "Optional BLS registration key (free, raises the daily cap from ~25 to 500). The gateway supplies a platform key; pass your own only to override.",
      +  "type": "string"
      +}
  3. Changed2 schema fields changed
    • addedInput schema / examples
      Added value: +[
      +  {
      +    "series_id": "CUUR0000SA0"
      +  },
      +  {
      +    "end_year": "2024",
      +    "series_id": "LNS14000000",
      +    "start_year": "2020"
      +  }
      +]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "data": {
      +      "description": "Time series data points",
      +      "items": {
      +        "properties": {
      +          "period": {
      +            "description": "Period code (e.g., M01 for January)",
      +            "type": "string"
      +          },
      +          "period_name": {
      +            "description": "Human-readable period name (e.g., January)",
      +            "type": "string"
      +          },
      +          "value": {
      +            "description": "Numeric value for the period",
      +            "type": "number"
      +          },
      +          "year": {
      +            "description": "Year of the data point",
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "year",
      +          "period",
      +          "period_name",
      +          "value"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "end_year": {
      +      "description": "End year filter if provided, null otherwise",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "series_id": {
      +      "description": "BLS series ID requested",
      +      "type": "string"
      +    },
      +    "start_year": {
      +      "description": "Start year filter if provided, null otherwise",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "total": {
      +      "description": "Total number of data points returned",
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "series_id",
      +    "start_year",
      +    "end_year",
      +    "total",
      +    "data"
      +  ],
      +  "type": "object"
      +}
  4. Changed2 schema fields changed
    • removedInput schema / examples
      Removed value: -[
      -  {
      -    "series_id": "CUUR0000SA0"
      -  },
      -  {
      -    "end_year": "2024",
      -    "series_id": "LNS14000000",
      -    "start_year": "2020"
      -  }
      -]
    • changedOutput schema / (root)
      Previous value: -{
      -  "properties": {
      -    "data": {
      -      "description": "Time series data points",
      -      "items": {
      -        "properties": {
      -          "period": {
      -            "description": "Period code (e.g., M01 for January)",
      -            "type": "string"
      -          },
      -          "period_name": {
      -            "description": "Human-readable period name (e.g., January)",
      -            "type": "string"
      -          },
      -          "value": {
      -            "description": "Numeric value for the period",
      -            "type": "number"
      -          },
      -          "year": {
      -            "description": "Year of the data point",
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "year",
      -          "period",
      -          "period_name",
      -          "value"
      -        ],
      -        "type": "object"
      -      },
      -      "type": "array"
      -    },
      -    "end_year": {
      -      "description": "End year filter if provided, null otherwise",
      -      "type": [
      -        "string",
      -        "null"
      -      ]
      -    },
      -    "series_id": {
      -      "description": "BLS series ID requested",
      -      "type": "string"
      -    },
      -    "start_year": {
      -      "description": "Start year filter if provided, null otherwise",
      -      "type": [
      -        "string",
      -        "null"
      -      ]
      -    },
      -    "total": {
      -      "description": "Total number of data points returned",
      -      "type": "integer"
      -    }
      -  },
      -  "required": [
      -    "series_id",
      -    "start_year",
      -    "end_year",
      -    "total",
      -    "data"
      -  ],
      -  "type": "object"
      -}New value: +null
  5. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "data": {
      +      "description": "Time series data points",
      +      "items": {
      +        "properties": {
      +          "period": {
      +            "description": "Period code (e.g., M01 for January)",
      +            "type": "string"
      +          },
      +          "period_name": {
      +            "description": "Human-readable period name (e.g., January)",
      +            "type": "string"
      +          },
      +          "value": {
      +            "description": "Numeric value for the period",
      +            "type": "number"
      +          },
      +          "year": {
      +            "description": "Year of the data point",
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "year",
      +          "period",
      +          "period_name",
      +          "value"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "end_year": {
      +      "description": "End year filter if provided, null otherwise",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "series_id": {
      +      "description": "BLS series ID requested",
      +      "type": "string"
      +    },
      +    "start_year": {
      +      "description": "Start year filter if provided, null otherwise",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "total": {
      +      "description": "Total number of data points returned",
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "series_id",
      +    "start_year",
      +    "end_year",
      +    "total",
      +    "data"
      +  ],
      +  "type": "object"
      +}
  6. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
      +  {
      +    "series_id": "CUUR0000SA0"
      +  },
      +  {
      +    "end_year": "2024",
      +    "series_id": "LNS14000000",
      +    "start_year": "2020"
      +  }
      +]
  7. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, openWorldHint, and idempotentHint, so the safety profile is covered. The description adds value by specifying the return shape ('historical data points with dates and values') and giving recognizable examples, which helps an agent anticipate behavior. No contradiction with annotations.

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

Conciseness5/5

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

Two sentences with no filler. The core purpose is front-loaded, and the examples are compact and illustrative. Every part of the description earns its place.

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 a rich schema, annotations, and an output schema, the description covers what an agent needs to safely call the tool. The main missing elements are explicit routing to siblings and default date-range behavior when start_year/end_year are omitted, but these are not critical given the existing structure.

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?

Input schema coverage is 100%, with each parameter already described in full, so the baseline is 3. The description adds helpful real-world series ID examples but does not add meaning beyond the schema for start_year, end_year, or _apiKey.

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 ('Fetch'), a resource ('economic time series'), and the key selection mechanism ('by ID'). Concrete examples of well-known series IDs make it immediately clear what the tool does and distinguish it from specialized siblings like get_cpi and get_unemployment.

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?

The description implies through 'any economic time series by ID' that this is the general-purpose tool, while siblings like get_cpi are specialized. However, it never explicitly says when to prefer this tool over the convenience siblings, and there is no when-not guidance.

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.