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

UK property data MCP for Codex CLI

OpenAI's terminal-native coding agent. Install the Homedata MCP and Codex CLI 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 Codex CLI best.

How do I install the Homedata MCP in Codex CLI?

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

Add to

~/.codex/config.toml

Codex CLI uses a TOML config. The mcp_servers section accepts the same command/args/env triple as JSON-based clients.

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

[mcp_servers.homedata]
command = "npx"
args = ["-y", "homedata-mcp"]

[mcp_servers.homedata.env]
HOMEDATA_API_KEY = "your_api_key_here"
Restart Codex CLI after saving. Run /mcp inside Codex to confirm the homedata tools loaded.

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 Codex CLI:

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 Codex CLI

Restart Codex CLI after saving. Run /mcp inside Codex to confirm the homedata tools loaded.

CLI quickstart — homedata commands for Codex CLI users

The same package ships a homedata CLI on your PATH. Useful for one-off lookups, shell scripts, or piping property data back into Codex CLI 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 Codex CLI.

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 Codex CLI ask about UK property?

Typed tools Codex CLI 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.

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

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.

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

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.

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

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

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

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

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 Codex CLI and Homedata

Concrete jobs the Homedata MCP unlocks inside Codex CLI.

Build a property-data agent — have Codex generate a script that lookups EPC and risk on every UPRN in a list.

Use Codex CLI to scaffold a UK property search feature against the real Homedata API without manually wiring SDKs.

Codex CLI + Homedata MCP — frequently asked questions

How do I add an MCP server to Codex CLI?
Codex CLI's config lives at ~/.codex/config.toml. Add an [mcp_servers.homedata] block with command = "homedata-mcp" and env = { HOMEDATA_API_KEY = "…" }. Save and re-launch Codex — /mcp will list homedata as connected.
Does Codex CLI support all the homedata-mcp tools?
Yes. Codex CLI implements the full MCP tool spec, so every tool the homedata server exposes — address search, EPC, flood, planning, schools and more — is available to the agent.
What Python version does Codex CLI need for homedata-mcp?
Python 3.10 or newer. The homedata-mcp wheel installs cleanly into any recent Python; Codex CLI itself is unaffected by the Python version because the MCP server runs as a separate process.
Does the Homedata MCP work with the free tier?
Yes — the free Homedata tier (no credit card required) works in Codex CLI 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 Codex CLI?
Pick Node for Codex CLI — 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 Codex CLI 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 Codex CLI.

Plug 29 million UK properties into Codex CLI

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

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