Skip to main content
Glama

Housing Intel

by io.github.pipeworx-io

Housing Affordability Check

housing_affordability_check
Read-onlyIdempotent

Check housing affordability in a market. Returns mortgage rate, median price, monthly payment, required income, and HUD limits. Optionally specify metro (e.g., "Denver").

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
stateNoState name or two-letter code (e.g., "California" or "CA"). Resolved for you — pass this rather than state_code. Optional: without it you still get the national mortgage rate, median price and affordability math, just no HUD income limits.
_blsKeyNoBLS registration key (optional — raises the shared quota; https://data.bls.gov/registrationEngine/)
_hudKeyNoHUD API token (optional — needed for income limits)
_fredKeyNoFRED API key
metro_nameNoMetro name for metro-level FHFA HPI (e.g., "Denver", "Savannah"). Optional.
state_codeNoTwo-letter state code for HUD income limits (e.g., "CO"). `state` is preferred and accepts either form.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
marketNoMarket identifier (metro or 'National')
metro_hpiNo
mortgage_rateNoCurrent 30-year mortgage rate (percent)
hud_income_limitsNo
median_home_priceNoMedian home price (USD)
affordability_dateNoToday's date in YYYY-MM-DD format
avg_hourly_earningsNoAverage hourly earnings for production/nonsup workers (USD)
annual_income_neededNoRequired annual income (at 28% housing expense ratio)
estimated_monthly_paymentNoEstimated monthly PITI (20% down, 30yr fixed)

Schema Changelog

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

  1. Changed1 schema field changed
    • addedInput schema / properties / _blsKey
      Added value: +{
+  "description": "BLS registration key (optional — raises the shared quota; https://data.bls.gov/registrationEngine/)",
+  "type": "string"
+}
  2. Changed2 schema fields changed
    • changedInput schema / examples
      Previous value: -[
-  {
-    "_fredKey": "your-housing-intel-api-key",
-    "state_code": "CO"
-  },
-  {
-    "_fredKey": "your-housing-intel-api-key",
-    "_hudKey": "your-housing-intel-api-key",
-    "metro_name": "Denver",
-    "state_code": "CO"
-  }
-]New value: +[
+  {
+    "state_code": "CO"
+  },
+  {
+    "metro_name": "Denver",
+    "state_code": "CO"
+  }
+]
    • changedInput schema / required
      Previous value: -[
-  "_fredKey"
-]New value: +[]
  3. Changed1 schema field changed
    • changedInput schema / examples
      Previous value: -[
-  {
-    "_fredKey": "your-housing-intel-api-key",
-    "state_code": "CO"
-  },
-  {
-    "_fredKey": "your-housing-intel-api-key",
-    "_hudKey": "your-housing-intel-api-key",
-    "metro_name": "Denver",
-    "state_code": "CO",
-    "zip_code": "80212"
-  }
-]New value: +[
+  {
+    "_fredKey": "your-housing-intel-api-key",
+    "state_code": "CO"
+  },
+  {
+    "_fredKey": "your-housing-intel-api-key",
+    "_hudKey": "your-housing-intel-api-key",
+    "metro_name": "Denver",
+    "state_code": "CO"
+  }
+]
  4. Changed1 schema field changed
    • removedInput schema / properties / zip_code
      Removed value: -{
-  "description": "ZIP code for more specific HUD data (optional)",
-  "type": "string"
-}
  5. Changed1 schema field changed
    • changedOutput schema / properties / metro_hpi / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
  6. Changed3 schema fields changed
    • addedInput schema / properties / state
      Added value: +{
+  "description": "State name or two-letter code (e.g., \"California\" or \"CA\"). Resolved for you — pass this rather than state_code. Optional: without it you still get the national mortgage rate, median price and affordability math, just no HUD income limits.",
+  "type": "string"
+}
    • changedInput schema / properties / state_code / description
      Previous value: -"Two-letter state code for HUD income limits (e.g., \"CO\")"New value: +"Two-letter state code for HUD income limits (e.g., \"CO\"). `state` is preferred and accepts either form."
    • changedInput schema / required
      Previous value: -[
-  "_fredKey",
-  "state_code"
-]New value: +[
+  "_fredKey"
+]
  7. Changed19 schema fields changed
    • addedOutput schema / properties / affordability_date
      Added value: +{
+  "description": "Today's date in YYYY-MM-DD format",
+  "type": "string"
+}
    • addedOutput schema / properties / annual_income_needed
      Added value: +{
+  "description": "Required annual income (at 28% housing expense ratio)",
+  "type": [
+    "number",
+    "null"
+  ]
+}
    • changedOutput schema / properties / avg_hourly_earnings / description
      Previous value: -"Average hourly earnings"New value: +"Average hourly earnings for production/nonsup workers (USD)"
    • removedOutput schema / properties / case_shiller_index
      Removed value: -{
-  "type": [
-    "number",
-    "null"
-  ]
-}
    • changedOutput schema / properties / estimated_monthly_payment / description
      Previous value: -"Estimated monthly payment (20% down, 30yr fixed)"New value: +"Estimated monthly PITI (20% down, 30yr fixed)"
    • addedOutput schema / properties / hud_income_limits / oneOf
      Added value: +[
+  {
+    "properties": {
+      "areas": {
+        "description": "HUD income limit areas (metro/county, up to 10)",
+        "items": {
+          "properties": {
+            "ami": {
+              "description": "Area median income (USD)",
+              "type": [
+                "number",
+                "null"
+              ]
+            },
+            "ami_percent": {
+              "description": "Area median income percentage",
+              "type": [
+                "number",
+                "null"
+              ]
+            },
+            "area_name": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "limit_120": {
+              "description": "120% AMI income limit (USD)",
+              "type": [
+                "number",
+                "null"
+              ]
+            },
+            "limit_30": {
+              "description": "30% AMI income limit (USD)",
+              "type": [
+                "number",
+                "null"
+              ]
+            },
+            "limit_50": {
+              "description": "50% AMI income limit (USD)",
+              "type": [
+                "number",
+                "null"
+              ]
+            },
+            "limit_80": {
+              "description": "80% AMI income limit (USD)",
+              "type": [
+                "number",
+                "null"
+              ]
+            }
+          },
+          "type": "object"
+        },
+        "type": "array"
+      },
+      "state": {
+        "description": "State code",
+        "type": "string"
+      },
+      "year": {
+        "description": "Income limit year",
+        "type": "string"
+      }
+    },
+    "type": "object"
+  },
+  {
+    "properties": {
+      "error": {
+        "type": "string"
+      }
+    },
+    "type": "object"
+  }
+]
    • removedOutput schema / properties / hud_income_limits / properties
      Removed value: -{
-  "error": {
-    "type": "string"
-  },
-  "extremely_low_4person": {
-    "type": [
-      "number",
-      "null"
-    ]
-  },
-  "low_4person": {
-    "type": [
-      "number",
-      "null"
-    ]
-  },
-  "median_income": {
-    "type": [
-      "number",
-      "null"
-    ]
-  },
-  "note": {
-    "type": "string"
-  },
-  "raw_response": {
-    "type": "object"
-  },
-  "state": {
-    "type": "string"
-  },
-  "very_low_4person": {
-    "type": [
-      "number",
-      "null"
-    ]
-  },
-  "year": {
-    "type": [
-      "number",
-      "null"
-    ]
-  }
-}
    • removedOutput schema / properties / hud_income_limits / type
      Removed value: -"object"
    • removedOutput schema / properties / income_needed
      Removed value: -{
-  "description": "Annual income needed for DTI 28%",
-  "type": [
-    "number",
-    "null"
-  ]
-}
    • removedOutput schema / properties / income_needed_note
      Removed value: -{
-  "type": "string"
-}
    • addedOutput schema / properties / market
      Added value: +{
+  "description": "Market identifier (metro or 'National')",
+  "type": "string"
+}
    • changedOutput schema / properties / median_home_price / description
      Previous value: -"National median home price in dollars"New value: +"Median home price (USD)"
    • removedOutput schema / properties / median_home_price_note
      Removed value: -{
-  "type": "string"
-}
    • addedOutput schema / properties / metro_hpi / properties / current / description
      Added value: +"Latest metro HPI value"
    • addedOutput schema / properties / metro_hpi / properties / error
      Added value: +{
+  "type": "string"
+}
    • removedOutput schema / properties / metro_hpi / properties / metro
      Removed value: -{
-  "type": "string"
-}
    • addedOutput schema / properties / metro_hpi / properties / series / description
      Added value: +"FRED FHFA HPI series ID"
    • changedOutput schema / properties / mortgage_rate / description
      Previous value: -"Current 30-year mortgage rate (%)"New value: +"Current 30-year mortgage rate (percent)"
    • removedOutput schema / required
      Removed value: -[
-  "mortgage_rate",
-  "median_home_price",
-  "median_home_price_note",
-  "case_shiller_index",
-  "avg_hourly_earnings",
-  "estimated_monthly_payment",
-  "income_needed",
-  "income_needed_note",
-  "hud_income_limits"
-]
  8. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "avg_hourly_earnings": {
+      "description": "Average hourly earnings",
+      "type": [
+        "number",
+        "null"
+      ]
+    },
+    "case_shiller_index": {
+      "type": [
+        "number",
+        "null"
+      ]
+    },
+    "estimated_monthly_payment": {
+      "description": "Estimated monthly payment (20% down, 30yr fixed)",
+      "type": [
+        "number",
+        "null"
+      ]
+    },
+    "hud_income_limits": {
+      "properties": {
+        "error": {
+          "type": "string"
+        },
+        "extremely_low_4person": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "low_4person": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "median_income": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "note": {
+          "type": "string"
+        },
+        "raw_response": {
+          "type": "object"
+        },
+        "state": {
+          "type": "string"
+        },
+        "very_low_4person": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "year": {
+          "type": [
+            "number",
+            "null"
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "income_needed": {
+      "description": "Annual income needed for DTI 28%",
+      "type": [
+        "number",
+        "null"
+      ]
+    },
+    "income_needed_note": {
+      "type": "string"
+    },
+    "median_home_price": {
+      "description": "National median home price in dollars",
+      "type": [
+        "number",
+        "null"
+      ]
+    },
+    "median_home_price_note": {
+      "type": "string"
+    },
+    "metro_hpi": {
+      "properties": {
+        "current": {
+          "type": "number"
+        },
+        "metro": {
+          "type": "string"
+        },
+        "series": {
+          "type": "string"
+        },
+        "trend": {
+          "enum": [
+            "rising",
+            "falling",
+            "stable"
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "mortgage_rate": {
+      "description": "Current 30-year mortgage rate (%)",
+      "type": [
+        "number",
+        "null"
+      ]
+    }
+  },
+  "required": [
+    "mortgage_rate",
+    "median_home_price",
+    "median_home_price_note",
+    "case_shiller_index",
+    "avg_hourly_earnings",
+    "estimated_monthly_payment",
+    "income_needed",
+    "income_needed_note",
+    "hud_income_limits"
+  ],
+  "type": "object"
+}
  9. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
+  {
+    "_fredKey": "your-housing-intel-api-key",
+    "state_code": "CO"
+  },
+  {
+    "_fredKey": "your-housing-intel-api-key",
+    "_hudKey": "your-housing-intel-api-key",
+    "metro_name": "Denver",
+    "state_code": "CO",
+    "zip_code": "80212"
+  }
+]
  10. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare read-only and idempotent behavior, so the description doesn't need to cover safety. It adds the scope of returning affordability metrics and the optional metro filter, but does not mention API key requirements or fallback data behavior, which are deferred to the schema. Adequate but not richly transparent.

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?

The description is three short, punchy sentences: purpose, outputs, and usage hint. No wasted words, front-loaded with the action, and the example adds clarity.

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 6 optional parameters and an output schema present, the description covers the essential purpose and key optional usage (metro). It does not mention the state/national fallback or API keys, but the schema handles those details, so the description is sufficient for tool selection and basic invocation.

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 the schema already documents all parameters well. The description only reinforces the optional metro parameter with an example, adding marginal value beyond the schema. Baseline 3 is appropriate.

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?

The description clearly states a specific verb ('Check') and resource ('housing affordability in a market'), and enumerates concrete outputs (mortgage rate, median price, monthly payment, required income, HUD limits). This distinguishes it from sibling housing tools like housing_market_snapshot or housing_mortgage_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?

The purpose is clear enough to infer when to use it, and the optional metro example gives usage context. However, it does not explicitly mention alternatives or when not to use this tool, so it stops short of full guidance.

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

All Housing Intel toolsInspect
Try in Browser
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A3.6/5.0
Disambiguation2/5

Several tools intentionally overlap: ask_pipeworx, ask_pipeworx_beta, and ask_pipeworx_grounded share the same router, with the beta variant explicitly matching stable behavior right now. entity_profille/recent_changes/compare_entities and the multiple polymarket scanning tools also cover closely related jobs, so an agent must read carefully to avoid picking the wrong variant.

Naming Consistency3/5

All tools use lowercase snake_case, which is a consistent base style. However, the naming grammar is mixed: proper verb_noun tools like compare_entities and validate_claim sit beside noun-phrase/domain tools like housing_market_screen and polymarket_edges, plus the awkward compound case_shiller_metro_compare. The housing_ and polymarket_ prefixes help, but the pattern is not uniform enough for a 5.

Tool Count2/5

41 tools far exceeds the 25+ threshold and the typical well-scoped 3-15 range. Many tools pertyain to Polymarket, npm scanning, llms.txt generation, and memory, which have little to do with Housing Intel, so the count is not earned by the server's stated domain.

Completeness4/5

For the housing domain specifically, the coverage is strong: market snapshot, affordability, employment, mortgage history, rental/property analysis, metro demand, signal scanning, and Case-Shiller comparisons cover the main data needs. The generic ask_pipeworx and deep_research tools also backfill specialized queries. The weakness is scope blur, not obvious missing housing operations.

Resources