Skip to main content
Glama

fhfa_hpi_series

Read-onlyIdempotent

Return a bounded FHFA House Price Index history for one US geography from LiveDataLink's self-hosted official snapshot. Includes stable FHFA place_id, geography level, year/period, adjusted and unadjusted index values, pagination, snapshot hash, and required attribution. Use this for 'show California house-price history', 'chart the Austin metro HPI', or as a federal price-index leg alongside realestate_trend. The index measures average price change; it is not a property value or appraisal.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum observations. Default 24.
placeYesExact FHFA place_id or geography name, such as 'CA', 'California', a 5-digit CBSA id, or an FHFA metro name.
offsetNoObservations to skip for pagination. Default 0.
end_yearNoOptional latest observation year.
frequencyNoObservation frequency. Default quarterly.
hpi_flavorNoFHFA index flavor. Default purchase-only.
start_yearNoOptional earliest observation year.
index_basisNoIndex column to use. Default seasonally_adjusted.
geography_levelNoOptional exact FHFA geography level to disambiguate state, metro, division, or national series.
response_formatNoHuman-readable markdown or machine-readable JSON. Default markdown.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed15 schema fields changed
    • addedInput schema / properties / end_year / maximum
      Added value: +2100
    • addedInput schema / properties / end_year / minimum
      Added value: +1970
    • changedInput schema / properties / end_year / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / geography_level / maxLength
      Added value: +100
    • addedInput schema / properties / limit / maximum
      Added value: +240
    • addedInput schema / properties / limit / minimum
      Added value: +1
    • changedInput schema / properties / limit / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / offset / maximum
      Added value: +5000
    • addedInput schema / properties / offset / minimum
      Added value: +0
    • changedInput schema / properties / offset / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / place / maxLength
      Added value: +120
    • addedInput schema / properties / place / minLength
      Added value: +1
    • addedInput schema / properties / start_year / maximum
      Added value: +2100
    • addedInput schema / properties / start_year / minimum
      Added value: +1970
    • changedInput schema / properties / start_year / type
      Previous value: -"number"New value: +"integer"
  2. Added

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive, and openWorld, so the safety profile is covered. The description adds that the data comes from a 'self-hosted official snapshot' and mentions a snapshot hash and required attribution, which is useful provenance context. It does not add further behavioral detail such as rate limits or exact pagination semantics, so a 3 is appropriate.

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?

Four sentences, front-loaded with the core purpose, followed by returned fields, usage examples, and a scope clarification. No wasted filler. The final sentence earns its place by preventing misuse as a valuation tool.

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 annotations covering safety and a fully-described 10-parameter schema, the description covers purpose, return fields, provenance, and a key scope limit. It could be stronger by explicitly routing users to fhfa_hpi_trend and fhfa_hpi_compare, but it is otherwise complete for a read-only index query.

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 every parameter is already documented in the schema, establishing the baseline of 3. The description adds no syntax or format detail beyond the schema (e.g., no guidance on how place names are matched), so it does not exceed baseline.

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 and resource ('Return a bounded FHFA House Price Index history for one US geography') and enumerates the returned fields including stable place_id, geography level, year/period, and both index flavors. It does not explicitly contrast itself with the sibling tools fhfa_hpi_trend and fhfa_hpi_compare, so it falls short of full sibling differentiation.

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?

Provides concrete example queries ('show California house-price history', 'chart the Austin metro HPI') and names a use context ('as a federal price-index leg alongside realestate_trend'). However, it never states when NOT to use it versus the closer siblings fhfa_hpi_trend and fhfa_hpi_compare, leaving the boundary ambiguous.

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.