Skip to main content
Free UK property data API Start free →
Windsurf PyPI v0.2.0 npm v0.1.0

UK property data MCP for Windsurf

Codeium's agentic IDE built for flow. Install the Homedata MCP and Windsurf gains typed tools for 29 million UK properties — EPC, flood risk, planning, schools, transport — answered straight from your chat or agent. Ships as a Python package or a Node package; pick whichever fits Windsurf best.

Get a key Install in Windsurf ↓

How do I install the Homedata MCP in Windsurf?

Three steps: install the homedata-mcp package (Python or Node), drop in the config block, restart Windsurf.

Add to

~/.codeium/windsurf/mcp_config.json

Windsurf picks up new MCP servers on relaunch.

Recommended for Windsurf — runs via npx, no global install needed. Node 18+ required.

{
  "mcpServers": {
    "homedata": {
      "command": "npx",
      "args": ["-y", "homedata-mcp"],
      "env": {
        "HOMEDATA_API_KEY": "your_api_key_here"
      }
    }
  }
}
Restart Windsurf after saving. The Cascade panel shows the homedata tools alongside built-in ones.

Either edition exposes the same MCP tools and the same homedata CLI. Pick Node if you want zero-install via npx; pick Python if your AI client already embeds Python.

1. Install the server

Pick the runtime that fits Windsurf:

Python (pip) 
pip install homedata-mcp
Node (npm / npx) Recommended 
npm install -g homedata-mcp
# or zero-install via npx:
npx -y homedata-mcp

2. Get your API key

Sign up and copy your key from the developer dashboard. Paste it into HOMEDATA_API_KEY.

3. Restart Windsurf

Restart Windsurf after saving. The Cascade panel shows the homedata tools alongside built-in ones.

CLI quickstart — homedata commands for Windsurf users

The same package ships a homedata CLI on your PATH. Useful for one-off lookups, shell scripts, or piping property data back into Windsurf as context.

Install the CLI

Same homedata command in both editions.

Python (pip)

pip install homedata-mcp

Node (npm)

npm install -g homedata-mcp

Or run once, no install

npx -y homedata-mcp homedata --help
Set HOMEDATA_API_KEY in your shell before running any command — same key as the MCP server.

Common commands

Pipe into jq, fzf or feed straight back into Windsurf.

homedata search '10 downing street'

Type-ahead address search — get a UPRN for any UK address from your shell.

homedata property 100023336956

Full property record for any UPRN. Pipe into jq, fzf or your editor.

homedata epc 100023336956 --field current_energy_efficiency

EPC rating, score and recommendations from the official register.

homedata flood-risk 100023336956

Environment Agency flood risk — river, sea, surface and groundwater.

homedata planning --postcode "SW1A 1AA" --days 365

Recent planning applications for any postcode or local authority.

What can Windsurf ask about UK property?

Typed tools Windsurf gains the moment the Homedata MCP is connected. Each tool has its own anchor — link directly to #tool-lookup-epc, #tool-lookup-flood-risk and the rest.

search_address Free

Type-ahead UK address search across all 29 million properties — find a UPRN in milliseconds.

lookup_property Included

Pull the full property record for any UK UPRN — characteristics, tenure, build period and more.

lookup_epc Included

Energy performance certificate rating, score and recommendations from the official EPC register.

lookup_flood_risk Included

River, sea, surface and groundwater flood risk for any UK address — sourced from the Environment Agency.

get_planning_applications Included

Recent planning applications for a postcode or local authority — applicant, description, status, decision dates.

get_crime Included

Crime statistics for the surrounding area, broken down by category and month.

get_schools Included

Nearby state and independent schools with Ofsted rating, type and distance.

get_transport Included

Closest rail, tube and tram stations with walking distance and line information.

get_postcode_profile Included

Aggregated profile for any UK postcode — sales activity, average prices, area scores.

batch_property_lookup Included

Look up multiple properties at once — pass a list of UPRNs, get back full property records for each.

search_property_listings Paid plans

Live UK property listings from Home.co.uk — for sale, to rent, sold STC, price changes.

get_property_sales Paid plans

Land Registry sale history for a property — every transaction since 1995 with price and date.

Tools call the same endpoints documented on /docs/endpoints. Property data sourced from Home.co.uk, Land Registry, EPC register, Environment Agency, ONS, Ofsted and other authoritative UK sources. Sales, listings and comparables are surfaced for customers on higher-tier plans — see plans.

What developers build with Windsurf and Homedata

Concrete jobs the Homedata MCP unlocks inside Windsurf.

Pipe UK property data into Cascade — let Windsurf write valuation tooling against live EPC, planning and risk data.

Build a property report feature in your stack while Windsurf queries 29M UK properties in the same conversation.

Windsurf + Homedata MCP — frequently asked questions

How do I install the Homedata MCP in Windsurf?
Open ~/.codeium/windsurf/mcp_config.json (create the file if it's missing), paste the homedata block from this page, drop in your API key and relaunch Windsurf. Cascade picks the server up automatically.
Does the MCP work with Windsurf on macOS, Windows and Linux?
Yes — Windsurf is cross-platform and so is homedata-mcp. The path to mcp_config.json is the same on all three platforms under your home directory.
Can I see which tool Cascade is calling?
Yes. Cascade shows the tool name and arguments inline before it runs the call. That's also useful for debugging — if a tool errors, the response is shown in-chat with the error code.
Does the Homedata MCP work with the free tier?
Yes — the free Homedata tier (no credit card required) works in Windsurf as soon as you paste your API key into HOMEDATA_API_KEY. Higher-tier plans unlock larger monthly quotas and the property sales, listings and comparables tools.
Should I install the Python or Node edition for Windsurf?
Pick Node for Windsurf — npx -y homedata-mcp gives you zero-install setup. The Python edition is equivalent if you'd rather pip install once and avoid Node entirely.
How does the homedata CLI differ from the MCP server?
Both ship in the same package. The MCP server is what Windsurf talks to over the Model Context Protocol — typed tools, structured JSON. The homedata CLI is for humans — same data, but invokable as `homedata property`, `homedata epc`, `homedata flood-risk` directly in a terminal. Useful for piping into shell scripts or back into Windsurf.

Other MCP clients

The Homedata MCP works with every major MCP-compatible client. Same Python and Node packages, different install path.

Claude Desktop

Anthropic's official desktop app for Claude.

Install in Claude Desktop →

Claude Code

Anthropic's terminal-native coding agent.

Install in Claude Code →

Cursor

AI-first code editor built on VS Code.

Install in Cursor →

Codex CLI

OpenAI's terminal-native coding agent.

Install in Codex CLI →

Cline

VS Code extension by the Cline team — autonomous coding inside your editor.

Install in Cline →

Continue.dev

Open-source AI assistant for VS Code and JetBrains.

Install in Continue.dev →

Zed

High-performance, multiplayer code editor.

Install in Zed →

Or head back to the MCP hub for the full overview and the Python vs Node comparison.

Plug 29 million UK properties into Windsurf

Install in under sixty seconds. Free tier available; paid plans unlock sales, listings and comparables.

Get a key Read API docs View on GitHub

Latest releases: PyPI v0.2.0 · npm v0.1.0