Skip to main content
Glama

FreeRateUpdate Mortgage & Home Equity Shopping

Economic reference series

get_reference_series
Read-onlyIdempotent

Public reference time series FreeRateUpdate maintains (e.g. pmms_30yr_fixed, treasury_10yr_par), with license notes and observations. A missing or unknown series_key returns the valid keys.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "series_key": "<series_key>"
    },
    "name": "get_reference_series"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMost-recent N (default 52)
series_keyYesThe series to read, e.g. pmms_30yr_fixed. A missing or unknown key returns the valid keys.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / series_key / description
      Added value: +"The series to read, e.g. pmms_30yr_fixed. A missing or unknown key returns the valid keys."
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world). The description adds real behavioral context beyond them: the payload includes license notes and observations, and an unknown key degrades into a key listing rather than an error, which shapes how an agent should handle a failed lookup.

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 short sentences, front-loaded with the resource identity and followed by the discovery behavior. The unknown-key clause duplicates the schema, so it is not perfectly waste-free, but nothing is bloated.

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?

For a two-parameter read tool with no output schema, the description covers what the tool returns (license notes, observations) and how failures behave, which is the main gap a missing output schema would otherwise create. Only the default/explicit limit semantics are left to the schema.

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 coverage is 100% and both parameters are documented there, including the pattern for series_key and the 1-520 range for limit. The description only restates the unknown-key fallback that is already in the series_key schema text, adding no new meaning.

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?

States a specific verb+resource: reading public reference time series (with concrete examples like pmms_30yr_fixed, treasury_10yr_par) and what comes back (license notes, observations). This separates it from sibling rate tools such as get_mortgage_rates, though the distinction is implied by 'reference' rather than stated explicitly.

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?

No explicit when-to-use or when-not-to-use guidance versus the many sibling data tools. The one piece of actionable guidance is the discovery path: an unknown series_key returns the valid keys, which tells the agent it can probe safely, but usage context is otherwise left to inference.

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