Stayai-mcp-server

🚀 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

这将打开一个网络界面，您可以在其中：

• 查看可用工具和资源
• 使用不同输入测试工具
• 查看服务器日志和响应

✨ 主要特性

• 使用各种过滤器搜索物业
• 获取特定物业的详细信息
• 创建、获取、更新和取消预订
• 检查物业的可用性
• 计算停留的价格
• 管理客户档案

📦 安装指南

安装步骤

1. 克隆此仓库
2. 安装依赖项：

npm install

3. 创建包含你的Stay AI API密钥的.env文件：

STAY_AI_API_KEY=your_api_key_here

💻 使用示例

基础用法

以下是一些使用服务器工具的示例代码：

// 搜索物业
const { search_properties } = require('./path/to/mcp-server');
const properties = search_properties({ filter: 'your_filter_here' });
console.log(properties);

// 获取特定物业的详细信息
const { get_property_details } = require('./path/to/mcp-server');
const propertyDetails = get_property_details('property_id_here');
console.log(propertyDetails);

高级用法

// 创建新的预订
const { create_booking } = require('./path/to/mcp-server');
const newBooking = create_booking({ 
  propertyId: 'property_id_here', 
  customerId: 'customer_id_here', 
  startDate: 'start_date_here', 
  endDate: 'end_date_here' 
});
console.log(newBooking);

// 更新现有预订
const { update_booking } = require('./path/to/mcp-server');
const updatedBooking = update_booking('booking_id_here', { 
  startDate: 'new_start_date_here', 
  endDate: 'new_end_date_here' 
});
console.log(updatedBooking);

📚 详细文档

可用工具

• 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许可证。