Property Prices MCP

🚀 Real Estate Price Search MCP Server

A Model Context Protocol (MCP) server that allows users to search for real estate prices in the UK Land Registry by postcode, utilizing the HM Land Registry's SPARQL endpoint.

🚀 Quick Start

This MCP server enables users to search for UK real estate prices via postcode, leveraging the HM Land Registry's SPARQL endpoint.

✨ Features

• Search for real estate prices by postcode or a combination of street and city.
• Filter results by price range, property type, and date range.
• Connect to the public SPARQL endpoint of the HM Land Registry.
• Implement MCP stdio transmission to support IDE integration.
• Implemented in TypeScript with full type safety.
• Equipped with a comprehensive test suite.
• Provide a CLI interface for direct use.

📦 Installation

Global Installation

npm install -g property-prices-mcp

Local Installation

npm install property-prices-mcp

💻 Usage Examples

Basic Usage - Command Line Interface

property-prices-mcp

Advanced Usage - As a Library

import { McpClient } from '@modelcontextprotocol/sdk/client';

const client = new McpClient();
const result = await client.resource('property-prices').query({
  postcode: 'SW1A 1AA',
  minPrice: 1000000,
  propertyType: 'flat',
  limit: 5,
});

console.log(result);

📚 Documentation

Case Sensitivity

The data in the UK Land Registry is case-sensitive for street names and city names. However, this MCP automatically converts these parameters to uppercase before sending them to the Land Registry API, so you can use any case in your searches.

Example:

"Cherry Drive" and "CHERRY DRIVE" will both work correctly.

Search Parameters

The server accepts the following search parameters:

Response Format

The server will return a response in the following JSON format:

{
  "properties": {
    "price": number,
    "bedrooms": number,
    "bathrooms": number,
    "yearBuilt": number,
    "date": string,
    "location": string
  }
}

Error Handling

If an error occurs, the server will return an error response in the following JSON format:

{
  "error": {
    "code": number,
    "message": string
  }
}

Possible error codes and messages include:

• 400: "Invalid request parameters"
• 404: "Data not found"
• 500: "Internal server error"

Development

Please read CONTRIBUTING.md to understand our code of conduct and the process for submitting pull requests.

Changelog

Please check CHANGELOG.md for the list of changes and version history.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.