Property Price Search MCP Server

By joemclo GitHub

UK Property Price Search MCP Server

property-prices property-search

Overview

What is Property Price Search MCP Server?

Property Price Search MCP Server is a Model Context Protocol (MCP) server that enables users to search for property prices in the UK by postcode using the HM Land Registry's SPARQL endpoint.

How to use Property Price Search MCP Server?

To use the server, you can either install it globally or locally via npm. You can then use the command line interface or integrate it as a library in your TypeScript projects.

Key features of Property Price Search MCP Server?

Search property prices by postcode or street/city combination.
Filter results by price range, property type, and date range.
Connect to HM Land Registry's public SPARQL endpoint.
Implements MCP stdio transport for IDE integration.
TypeScript implementation with full type safety.
Comprehensive test suite and CLI interface for direct usage.

Use cases of Property Price Search MCP Server?

Finding property prices in specific UK postcodes.
Analyzing property price trends over time.
Filtering property searches based on various criteria like type and price range.

FAQ from Property Price Search MCP Server?

What is the minimum requirement to run the server?

Node.js >= 18 and npm >= 7 are required.

How can I install the server?

You can install it globally using npm install -g property-prices-mcp or locally using npm install property-prices-mcp.

What kind of search parameters can I use?

You can use parameters like postcode, street, city, minPrice, maxPrice, propertyType, and date range.

Content

Property Price Search MCP Server

A Model Context Protocol (MCP) server that allows users to search for property prices by postcode using the HM Land Registry's SPARQL endpoint.

Features

Search property prices by postcode or street/city combination
Filter results by price range, property type, and date range
Connect to HM Land Registry's public SPARQL endpoint
Implements MCP stdio transport for IDE integration
TypeScript implementation with full type safety
Comprehensive test suite
CLI interface for direct usage

Prerequisites

Node.js >= 18
npm >= 7

Installation

Global Installation

npm install -g property-prices-mcp

Local Installation

npm install property-prices-mcp

Usage

Command Line Interface

property-prices-mcp

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);

Search Parameters

The server accepts the following search parameters:

Parameter	Type	Description	Default
postcode	string	UK postcode to search	-
street	string	Street name	-
city	string	City name	-
minPrice	number	Minimum property price	-
maxPrice	number	Maximum property price	-
propertyType	string	One of: detached, semi-detached, terraced, flat, other	-
fromDate	string	Start date (YYYY-MM-DD)	-
toDate	string	End date (YYYY-MM-DD)	-
limit	number	Maximum number of results	10
offset	number	Number of results to skip	0
sortBy	string	Sort by 'date' or 'price'	'date'
sortOrder	string	Sort order 'asc' or 'desc'	'desc'

Response Format

The API returns results in the following format:

interface PropertyPrice {
  price: number;
  date: string;
  propertyType: string;
  newBuild: boolean;
  tenure: string;
  paon: string;
  saon?: string;
  street: string;
  locality?: string;
  town: string;
  district: string;
  county: string;
  postcode: string;
}

interface SearchResponse {
  results: PropertyPrice[];
  total: number;
  offset: number;
  limit: number;
}

Error Handling

The server returns standard HTTP status codes:

200: Successful request
400: Invalid parameters
404: No results found
500: Server error

Error responses include a message explaining the error:

{
  "error": "Invalid postcode format"
}

Development

Clone the repository:

git clone https://github.com/joemclo/property-prices-mcp.git
cd property-prices-mcp

Install dependencies:
```
npm install
```
Build the project:
```
npm run build
```

Run tests:

npm test                  # Run all tests
npm run test:unit        # Run unit tests only
npm run test:integration # Run integration tests only

Start in development mode:
```
npm run dev
```

Troubleshooting

Common Issues

SPARQL Endpoint Connection Issues
- Check your internet connection
- Verify the HM Land Registry endpoint is available
- Ensure your IP is not being rate limited
Invalid Postcode Format
- Ensure postcodes are in the correct UK format
- Remove any extra spaces
- Use uppercase letters
No Results Found
- Try broadening your search criteria
- Check if the date range is too narrow
- Verify the postcode exists

Contributing

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

Changelog

See CHANGELOG.md for a list of changes and version history.

License

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

No tools information available.

No content found.