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 文件。