Stayai MCP Server

🚀 Stay AI API MCP 服務器

Stay AI API MCP 服務器是一個用於Stay AI物業管理 API 的模型上下文協議（MCP）服務器。它藉助標準化工具和資源，讓 AI 模型能夠與該 API 實現交互，為物業管理提供了高效、便捷的解決方案。

🚀 快速開始

先決條件

• Node.js 16 或更高版本
• 一個 Stay AI API 密鑰

安裝

1. 克隆此倉庫
2. 安裝依賴項：

   npm install
   

3. 創建包含你的 Stay AI API 密鑰的 .env 文件：

   STAY_AI_API_KEY=your_api_key_here
   

運行服務器

啟動服務器：

npm run dev

使用 MCP Inspector 測試

使用 MCP Inspector 測試服務器：

npm run inspect

這將打開一個網絡界面，您可以在其中：

• 查看可用工具和資源
• 使用不同輸入測試工具
• 查看服務器日誌和響應

✨ 主要特性

• 使用各種過濾器搜索物業
• 獲取特定物業的詳細信息
• 創建、獲取、更新和取消預訂
• 檢查物業的可用性
• 計算停留的價格
• 管理客戶檔案

📦 安裝指南

先決條件

• Node.js 16 或更高版本
• 一個 Stay AI API 密鑰

安裝步驟

1. 克隆此倉庫
2. 安裝依賴項：

   npm install
   

3. 創建包含你的 Stay AI API 密鑰的 .env 文件：

   STAY_AI_API_KEY=your_api_key_here
   

💻 使用示例

基礎用法

// 這裡可以根據具體的使用場景添加基礎使用代碼示例
// 例如調用 search_properties 工具搜索物業
// 假設已經正確引入相關模塊和配置好環境
const { search_properties } = require('./your_module_path');
const filters = { /* 定義過濾器 */ };
const result = search_properties(filters);
console.log(result);

高級用法

// 高級場景說明：使用多個工具組合完成複雜業務，比如先搜索物業，再獲取其詳細信息
const { search_properties, get_property_details } = require('./your_module_path');
const filters = { /* 定義過濾器 */ };
const properties = search_properties(filters);
if (properties.length > 0) {
    const firstPropertyId = properties[0].id;
    const propertyDetails = get_property_details(firstPropertyId);
    console.log(propertyDetails);
}

📚 詳細文檔

可用工具

• search_properties：使用各種過濾器搜索物業
• get_property_details：獲取特定物業的詳細信息
• create_booking：為某個物業創建新的預訂
• get_booking：獲取特定預訂的詳細信息
• update_booking：更新現有預訂
• cancel_booking：取消現有預訂
• check_availability：檢查物業在特定日期是否可用
• calculate_price：計算停留的價格
• create_customer：創建新的客戶檔案
• get_customer：獲取特定客戶的詳細信息

可用資源

• property://{id}：獲取某個物業的詳細信息
• booking://{id}：獲取某個預訂的詳細信息

📄 許可證

本項目採用 MIT 許可證。