About compass-mcp
compass-mcp gives MCP clients access to Compass listings, property details, photos, and price history, along with comparison and mortgage calculations. Requests run through the user’s signed-in Compass browser tab, with listing data extracted from page content.
Key features
- 01Search listings by location and criteria
- 02Read property details, photos, and price history
- 03Compare properties and fetch records in bulk
- 04Find nearby rentals and agent listings
- 05Calculate affordability and mortgage payments
Use cases
- 01Filter homes by budget and bedroom count
- 02Review photos and listing price changes
- 03Compare several properties side by side
- 04Estimate an affordable price and mortgage
MCP support
It exposes property search, retrieval, comparison, and local calculation tools to MCP clients. Requests to Compass are routed through the user’s signed-in browser tab using the ContextMint Bridge extension.
Configuration
Local server config is the same for every client. Copy it into your client’s MCP config file.
npx -y compass-mcpCOMPASS_WS_PORTOverride the fetchproxy WebSocket port (default 37149).COMPASS_COMMUNITIES_FILEPath to a JSON string-array of community names for feature extraction; overrides the built-in Lake Lure / mountain-NC default vocabulary.Local servers need a runtime on your machine (e.g. Node.js 18+). Config file locations differ by client; see your client’s docs.
Tools
18Saved tool list · updated 2w ago
| Parameter | Type | Required | Description |
|---|---|---|---|
| view | enum | No | Response shape: "compact" (default) drops fields the response already carries elsewhere; "full" returns every field this server understands. compact strips image/avatar URLs from the response; "full" returns Compass's payload untouched. No field projection: this server has no verified record of which Compass fields matter, and inventing one would risk dropping a field a caller needs.compact | full |
| limit | integer | No | Max listings to return (default 40). Only the first SSR page (~41 listings) is reachable (#87), so a limit above that is capped by the page; use price/beds banding to reach more. |
| offset | integer | No | Zero-based offset into the reachable first SSR page. Honored only within that page (#87); use the `next_offset` value from a previous response to continue within it. An offset at or beyond the page returns no results — narrow with price/beds bands to reach more. Default 0. |
| beds_max | integer | No | |
| beds_min | integer | No | |
| location | string | Yes | Free-text location: city, ZIP, neighborhood (e.g. "Brooklyn, NY", "94110", "Park Slope") |
| home_type | enum | No | Restrict to a single property type.house | condo | townhouse | multi_family | land | rental |
| price_max | integer | No | |
| price_min | integer | No |
Details
From the project READMEcompass-mcp
Compass real-estate access as an MCP server for Claude — search listings, fetch property details, photo galleries, price history, and run affordability/mortgage math, all via natural language.
⚠️ Compass does not publish a public consumer API. This server scrapes the same server-rendered HTML compass.com itself ships to your browser, routed through your own signed-in browser tab via the ContextMint Bridge extension. Every request acts on behalf of your existing session — your cookies, your TLS, your JS context — exactly as if you'd clicked it in the browser yourself. Treat this as informal use of Compass's website. Use at your own discretion.
Tools
| Tool | Purpose | Auth-scoped |
|---|---|---|
compass_search_properties | Search listings by location, price band, beds, home type. Slugifies free-text into Compass's URL routing and extracts the SSR listings array. | |
compass_get_property | Full record for a property by URL or listing_id_sha. Address, neighborhood, beds/baths, sqft, lot, price + $/sqft, monthly charges, MLS status, amenities, schools, parcel number. | |
compass_get_property_photos | Full photo gallery — every image in listing.media[] with original + thumbnail URLs and pixel dimensions. Floorplans/other media gated behind include_all_categories. | |
compass_get_price_history | Full listing-history events (Listed / Sold / Pending / Price Change / Delisted) with date, price, status, and MLS attribution. Returns both this-listing and prior-listing aggregates. | |
compass_compare_properties | Side-by-side comparison of up to 25 properties with an opt-in aligned summary table. Per-target errors captured per-row. Concurrent fetches. | |
compass_calculate_affordability | Local affordability calculator — max purchase price from income + DTI + rates. No network. | |
compass_get_by_address | Resolve a free-text street address to the canonical Compass URL, listing_id_sha, and pid in one call. Returns { resolved: false, error: "no listing found" } rather than throwing when there is no match. | |
compass_resolve_addresses | Bulk version of compass_get_by_address: resolves many addresses in one call with the same rung walker and a per-row error contract. | |
compass_bulk_get | Fetch up to 200 listings by URL or listing_id_sha in one call. One row per target; per-target errors captured per-row. | |
compass_get_comparable_rentals | Nearby rental listings for a property, searched in the target's own city/state/ZIP. | |
compass_get_agent_listings | A Compass agent's active listings (closed deals via include_closed). | |
compass_calculate_mortgage | Local PITI calculator — principal+interest, taxes, insurance, HOA, PMI. No network. | |
compass_get_saved_homes | Not yet supported — Compass renders /overview/favorites via auth-scoped GraphQL we have not yet identified. Throws a clear "not yet wire" error. | ✓ |
compass_get_saved_searches | Not yet supported — same constraint as saved homes. | ✓ |
compass_healthcheck | Round-trips a no-op request through the bridge to confirm the WebSocket bridge, the extension and the signed-in compass.com tab are responsive. | |
compass_register_session | Register or refresh a logical session keyed by account identity (local; no network). | |
compass_set_active_session | Switch which registered session answers future requests (local). | |
compass_get_session_context | List the registered sessions and the active one (local). |
Response size
The listing read tools take an optional view argument: "compact" (the default) or "full". Compact strips image and avatar URLs (including primary_photo_url / primary_thumbnail_url) and keeps every other field; view: "full" returns the payload with those URLs intact.
Tools that take view: compass_search_properties, compass_get_property, compass_bulk_get, compass_compare_properties, compass_get_price_history, compass_get_comparable_rentals, compass_get_agent_listings, compass_get_by_address.
Changed in 1.1.9:
compass_get_property,compass_bulk_get,compass_compare_properties,compass_get_price_historyandcompass_get_comparable_rentalsused to return every field, media URLs included. They now default to compact like the other read tools. If you relied on photo or avatar URLs from these tools, passview: "full", or usecompass_get_property_photosfor the gallery.
compass_get_property_photos takes no view — its gallery URLs are the whole point of the tool, so it always returns them.
Acknowledgement of Terms
By using this MCP server, you acknowledge and agree to the following:
1. This server accesses your own Compass session. Every request is dispatched through your own browser tab via the ContextMint Bridge extension — your cookies, your TLS, your session. It does not — and cannot — access anyone else's account.
2. Compass's Terms of Use govern your use of this server, just as they govern your direct use of compass.com. The clauses most relevant here:
You may not automatedly crawl or query the Services for any purpose or by any means (including, without limitation, screen and database scraping, spiders, robots, crawlers and any other automated activity with the purpose of obtaining information from the Services) unless you have received prior express written permission from the applicable Compass Company.
And: "You agree to keep your password confidential, not use others' accounts, nor permit others to use your account."
You are agreeing to those terms — read by the maintainer 2026-05-23 — every time you invoke a tool in this server. Compass's terms prohibit automated crawling without written permission, and IDX listing data is licensed for personal, non-commercial use only.
3. Personal, non-commercial use only. This project is not affiliated with, endorsed by, sponsored by, or in partnership with Compass, Inc. It is a personal automation tool that reads the same server-rendered HTML compass.com itself ships to your browser. Do not use it to bulk-extract listings, redistribute IDX data, train AI models, populate a competing real-estate product, or for any commercial purpose.
4. Stability is not guaranteed. This server reads private inline-script state (global.uc.sharedReactAppProps, window.__INITIAL_DATA__.props.listingRelation.listing) and SSR URL conventions (/homes-for-sale/<slug>/, /homedetails/<slug>/<id>_lid/) that Compass may change without notice. It may break. It may stop working. That's by design — the surface is not theirs to maintain on our behalf.
5. You accept full responsibility for any consequences of using this server in connection with your Compass access — rate limiting, account suspension, IP blocks, AWS WAF challenges, or any enforcement action Compass takes. If Compass objects to your use, stop using this server.
This section is the maintainer's good-faith summary of the terms — it is not legal advice and does not modify or supersede Compass's actual ToU.
Install
Option A — npx (after first publish)
Add to .mcp.json:
{
"mcpServers": {
"compass": {
"command": "npx",
"args": ["-y", "compass-mcp"]
}
}
}
Option B — from source
git clone https://github.com/chrischall/compass-mcp
cd compass-mcp
npm install
npm run build
{
"mcpServers": {
"compass": {
"command": "node",
"args": ["/path/to/compass-mcp/dist/bundle.js"]
}
}
}
One-time browser setup
compass-mcp talks to your browser through the ContextMint Bridge extension, which is shared across every fetchproxy-based MCP (zillow-mcp, opentable-mcp, resy-mcp, …). Install it once from the ContextMint Bridge releases:
- Chrome: download the Chrome zip, unzip it, then
chrome://extensions→ toggle Developer mode → Load unpacked → pick the unzipped folder. - Safari: the bridge ships inside the ContextMint app; you enable it in Safari's settings. The ContextMint app has no public download yet, so there is no Safari install link to give — use Chrome for now.
Where it comes from. ContextMint Bridge is the fetchproxy browser extension under its new name, from the same maintainer — fetchproxy's own README (Extension) points to it. Its source is public at nullnet-app/contextmint-bridge: build it yourself (its README covers npm run build), or check a release zip against the .sha256 file published beside it:
shasum -a 256 -c contextmint-bridge-chrome-<version>.zip.sha256
Open compass.com and sign in. That's all the auth this server needs.
How it works
┌────────────────┐ stdio ┌──────────────────┐ WS ┌──────────────────┐ fetch() ┌─────────────┐
│ MCP client │◀────────▶│ dist/bundle.js │◀──────▶│ ContextMint │◀────────────▶│ compass.com │
│ (Claude, etc.) │ │ (Compass MCP) │ :37149 │ Bridge │ (real TLS, │ (your tab) │
└────────────────┘ └──────────────────┘ │ (separate) │ cookies) └─────────────┘
The MCP server runs in Node, but every HTTP call to compass.com is dispatched into your live browser tab through the ContextMint Bridge extension. Each request rides your existing session — TLS fingerprint, cookies, and JS execution context all match the page that's already on screen. No headless browser stand-in, no separate identity, no third-party proxy: just your real browser, acting on its own behalf, with the MCP server picking what to ask for.
Compass's pages are SSR React with no public JSON API — every tool extracts data from inline-script globals (global.uc.sharedReactAppProps on search pages, window.__INITIAL_DATA__.props.listingRelation.listing on homedetails). The client wraps that into the tool surface so callers never have to parse HTML themselves.
Commands
npm test # vitest, mocked transport, no network
npm run test:watch
npm run test:coverage
npm run build # tsc --noEmit + esbuild bundle → dist/bundle.js
npm run dev # node dist/bundle.js (after build)
License
MIT
Comments
New to MCP?
From what the protocol is to installing your first server, these answers cover most first questions.
An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.