MCP server

The MCP server is the main way to connect an AI agent. It uses the streamable HTTP transport.

• Endpoint: https://api.relmo.co/v1/mcp
• Auth: Authorization: Bearer <connector key>. See Authentication.
• Server name: relmo-listings

Tool descriptions and server instructions are served through MCP itself, so your client learns the recommended flow and the rules on data freshness and images when it connects.

Connect a clientCopy Anchor Link

Claude CodeCopy Anchor Link

claude mcp add --transport http relmo https://api.relmo.co/v1/mcp \
  --header "Authorization: Bearer <connector key>"

Other clientsCopy Anchor Link

Any client that supports remote streamable-HTTP MCP servers with custom headers works. Point it at the endpoint above and set the Authorization header.

{
  "mcpServers": {
    "relmo": {
      "url": "https://api.relmo.co/v1/mcp",
      "headers": { "Authorization": "Bearer <connector key>" }
    }
  }
}

The config format varies by client. Check its docs for how to add a remote MCP server.

ToolsCopy Anchor Link

suggestCopy Anchor Link

Resolve a place or developer name to a slug. Call it first when the buyer names a city, locality or developer.

Returns matches grouped by kind. Localities with published listings come first in popularLocalities; the rest are in localities.

{
  "popularLocalities": [
    {
      "name": "Worli Seaface",
      "slug": "worli-seaface",
      "citySlug": "mumbai",
      "cityName": "Mumbai",
      "ancestorPath": [
        { "name": "Worli", "slug": "worli" },
        { "name": "South Mumbai", "slug": "south-mumbai" }
      ]
    }
  ],
  "localities": [],
  "cities": [{ "slug": "mumbai", "name": "Mumbai" }],
  "developers": [{ "slug": "lodha", "name": "Lodha" }],
  "projects": [
    {
      "id": "…",
      "name": "…",
      "publicShortId": "…",
      "localityName": "Worli",
      "cityName": "Mumbai"
    }
  ]
}

ancestorPath runs from the immediate parent up to the root and excludes the city. A parent slug covers its whole subtree, so for "Worli" search at worli (which includes Worli Seaface) rather than listing each sub-area. Don't combine every similar name either: "Bandra" must not pull in "Bandra Kurla Complex". See Recommended flow.

market_statsCopy Anchor Link

Price, size and amenity figures for every matching project, not just one page. Takes the search filters.

{
  "totalCount": 42,
  "priceMin": 25000000,
  "priceMedian": 68000000,
  "priceMax": 350000000,
  "priceP25": 42000000,
  "priceP75": 110000000,
  "carpetAreaMin": 610,
  "carpetAreaMax": 4200,
  "bedroomsAvailable": [2, 3, 4],
  "readyCount": 9,
  "underConstructionCount": 33,
  "amenityCoverage": [{ "key": "swimming_pool", "count": 31 }],
  "examples": [{ "name": "…", "localityName": "Worli", "publicShortId": "…" }]
}

Prices are in rupees (₹) and areas in sq ft. amenityCoverage lists up to 12 amenities by how many projects offer them; examples has up to 5 projects.

search_listingsCopy Anchor Link

List matching projects, up to 12 per page. Takes the search filters plus sort and page.

{
  "items": [
    {
      "id": "…",
      "publicShortId": "…",
      "name": "…",
      "city": { "id": "…", "name": "Mumbai", "slug": "mumbai" },
      "locality": { "id": "…", "name": "Worli", "slug": "worli" },
      "salesStatus": "bookings_open",
      "constructionStatus": "under_construction",
      "possessionDate": "2028-12-31",
      "bedroomsAvailable": [3, 4],
      "priceFrom": 65000000,
      "priceTo": 140000000,
      "pricePerSqftMin": 52000,
      "pricePerSqftMax": 61000,
      "carpetAreaMin": 1250,
      "carpetAreaMax": 2300,
      "heroImageUrl": "https://…",
      "heroImageBlurDataUrl": "data:image/…"
    }
  ],
  "totalCount": 42,
  "page": 1,
  "perPage": 12,
  "totalPages": 4,
  "scopeCounts": { "inSearchQuery": 42, "aroundSearchQuery": 0 }
}

• Pass id to create_enquiry and publicShortId to get_listing.
• A null priceFrom means price on request. bedroomsAvailable uses 0 for a studio.
• Use totalCount to tell the buyer "N of M".

If a search filtered by city, localities or developer matches nothing, the response also carries a notice ({ "code": "no_matches", "message": "…" }). The usual cause is a guessed slug: resolve the name with suggest and retry.

get_listingCopy Anchor Link

Full detail for one project: phases, configurations, amenities and media.

An unknown slug returns an error. Resolve the name with suggest or search_listings and retry with the slug it returns.

create_enquiryCopy Anchor Link

Request a callback or book a site visit. The developer's sales team arranges the callback or visit.

Generate a fresh submission_id for each new enquiry and resend it unchanged on retries (for example after a network timeout). Repeats with the same key collapse into one, so a retry never double-books the buyer. The value must be a valid UUID; anything else is rejected.

Returns { "captured": true, "leadId": "..." }. Sometimes it returns { "captured": false, "leadId": null } instead. Treat that as received too.

Search filtersCopy Anchor Link

Shared by market_stats and search_listings. All are optional.

ErrorsCopy Anchor Link

Invalid arguments come back as a tool error, not an HTTP status. That includes a submission_id that isn't a UUID and an unknown project_id.