Property Prices MCP

🚀 房地产价格搜索 MCP 服务器

本项目是一个基于 Model Context Protocol (MCP) 的服务器，它能让用户通过邮编搜索英国土地注册处的房地产价格，借助 HM 土地注册处的 SPARQL 端点实现数据查询。

🚀 快速开始

本服务器允许用户通过邮编搜索英国土地注册处的房地产价格，使用 HM 土地注册处的 SPARQL 端点。你可以快速安装并使用它来查询相关房地产价格信息。

✨ 主要特性

• 支持按邮编或街道/城市组合搜索房地产价格，满足多样化的搜索需求。
• 可根据价格范围、房地产类型和日期范围筛选结果，精准定位所需信息。
• 连接 HM 土地注册处的公共 SPARQL 端点，确保数据来源的权威性。
• 实现 MCP stdio 传输以支持 IDE 集成，方便开发者使用。
• 使用 TypeScript 实现，具备完整的类型安全，提高代码的可靠性。
• 具有全面的测试套件，保障系统的稳定性。
• 提供 CLI 接口直接使用，操作简单便捷。

📦 安装指南

全局安装

npm install -g property-prices-mcp

本地安装

npm install property-prices-mcp

💻 使用示例

基础用法

命令行界面

property-prices-mcp

作为库使用

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

📚 详细文档

使用注意事项

⚠️ 重要提示

英国土地注册处的数据对街道名称和城市名称的大小写是敏感的。但是，此 MCP 会在发送到 land registry API 之前自动将这些参数转换为大写，因此您可以在搜索中使用任意大小写的字符。

示例：

"Cherry Drive" 和 "CHERRY DRIVE" 都会正确工作。

搜索参数

服务器接受以下搜索参数：

响应格式

服务器将返回以下 JSON 格式的响应：

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

错误处理

如果发生错误，服务器将返回以下 JSON 格式的错误响应：

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

可能的错误代码和消息包括：

• 400: "无效请求参数"
• 404: "未找到数据"
• 500: "服务器内部错误"

开发

请阅读 CONTRIBUTING.md 以了解我们的行为准则以及提交拉取请求的过程。

变更日志

请查看 CHANGELOG.md 以获取变更列表和版本历史记录。

📄 许可证

此项目根据 MIT 许可证发布 - 有关详细信息，请参阅 LICENSE 文件。