io.github.mattlong-plux/hostaway
Hostaway PMS: reservations, listings, calendars, financials, and guest messaging.
التثبيت
أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: .cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).
@matt-long-plux/hostaway-mcpclaude mcp add hostaway -e 'HOSTAWAY_ACCOUNT_ID=<HOSTAWAY_ACCOUNT_ID>' -e 'HOSTAWAY_CLIENT_SECRET=<your hostaway_client_secret>' -e 'HOSTAWAY_READ_ONLY=<HOSTAWAY_READ_ONLY>' -e 'HOSTAWAY_CACHE_TTL=<HOSTAWAY_CACHE_TTL>' -- npx -y @matt-long-plux/hostaway-mcp@1.0.1
{
"mcpServers": {
"hostaway": {
"command": "npx",
"args": [
"-y",
"@matt-long-plux/hostaway-mcp@1.0.1"
],
"env": {
"HOSTAWAY_ACCOUNT_ID": "<HOSTAWAY_ACCOUNT_ID>",
"HOSTAWAY_CLIENT_SECRET": "<your hostaway_client_secret>",
"HOSTAWAY_READ_ONLY": "<HOSTAWAY_READ_ONLY>",
"HOSTAWAY_CACHE_TTL": "<HOSTAWAY_CACHE_TTL>"
}
}
}
}
متغيرات البيئة
HOSTAWAY_ACCOUNT_IDإلزامي Your Hostaway account ID (integer)HOSTAWAY_CLIENT_SECRETإلزامي سري Your Hostaway API client secretHOSTAWAY_READ_ONLYSet to 'true' to disable all write/mutation toolsHOSTAWAY_CACHE_TTLToken cache TTL in seconds when API doesn't provide expires_in (default: 240)
التوثيق
مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.
المحتويات
hostaway-mcp
An open-source Model Context Protocol (MCP) server that connects AI assistants like Claude Desktop, Claude Code, and Cursor to the Hostaway property management API. Query reservations, listings, calendars, financials, and guest conversations using natural language.
Quick Start
- Get your Account ID and Client Secret from your Hostaway dashboard under Settings > API
- Make sure you have Node.js 18+ installed
- Pick your AI client below and add the config — no cloning or building required
Setup
Claude Desktop (Mac & Windows)
Open your Claude Desktop config file:
- Mac:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
Add the following (merge with existing mcpServers if you have other servers configured):
{
"mcpServers": {
"hostaway": {
"command": "npx",
"args": ["-y", "@matt-long-plux/hostaway-mcp"],
"env": {
"HOSTAWAY_ACCOUNT_ID": "YOUR_ACCOUNT_ID",
"HOSTAWAY_CLIENT_SECRET": "YOUR_CLIENT_SECRET"
}
}
}
}
Restart Claude Desktop and you're ready to go.
Claude Code
Option 1 — CLI command (quickest):
claude mcp add hostaway \
-e HOSTAWAY_ACCOUNT_ID=YOUR_ACCOUNT_ID \
-e HOSTAWAY_CLIENT_SECRET=YOUR_CLIENT_SECRET \
-- npx -y @matt-long-plux/hostaway-mcp
Option 2 — .mcp.json in your project root (good for sharing with teammates):
{
"mcpServers": {
"hostaway": {
"command": "npx",
"args": ["-y", "@matt-long-plux/hostaway-mcp"],
"env": {
"HOSTAWAY_ACCOUNT_ID": "YOUR_ACCOUNT_ID",
"HOSTAWAY_CLIENT_SECRET": "YOUR_CLIENT_SECRET"
}
}
}
}
Cursor
Add the same config to your project's .cursor/mcp.json, or go to Cursor Settings > MCP Servers > Add Server and paste:
{
"mcpServers": {
"hostaway": {
"command": "npx",
"args": ["-y", "@matt-long-plux/hostaway-mcp"],
"env": {
"HOSTAWAY_ACCOUNT_ID": "YOUR_ACCOUNT_ID",
"HOSTAWAY_CLIENT_SECRET": "YOUR_CLIENT_SECRET"
}
}
}
}
Updating
If you installed a previous version via npx, your system may have a cached copy. To update to the latest release:
npx clear-npx-cache
Then restart your AI client (Claude Desktop, Cursor, etc.). The next launch will automatically pull the latest version.
Alternatively, you can pin @latest in your config to always fetch the newest version on each restart:
"args": ["-y", "@matt-long-plux/hostaway-mcp@latest"]
Tools Reference
Reservations
| Tool | Description | Key Parameters |
|---|---|---|
list_reservations | List reservations with filters | listingMapId, dateFrom, dateTo, status, channelId, limit |
get_reservation | Get full reservation details | reservationId (required) |
update_reservation_host_note | Update internal host note | reservationId, hostNote (required) |
list_reservations_by_property | Current + upcoming reservations grouped by property | None |
Listings
| Tool | Description | Key Parameters |
|---|---|---|
list_listings | All active listings with metadata | includeArchived |
get_listing | Full listing details | listingId (required) |
get_listing_custom_fields | Custom field values as name-value map | listingId (required) |
Calendar
| Tool | Description | Key Parameters |
|---|---|---|
get_calendar | Availability and pricing calendar | listingId, startDate, endDate (all required) |
get_gap_nights | Find short unbooked gaps between reservations | listingId (required), startDate, endDate, maxGapLength |
create_calendar_block | Block dates on calendar | listingId, startDate, endDate (required), note |
delete_calendar_block | Remove a calendar block | listingId, calendarBlockId (required) |
Financials
| Tool | Description | Key Parameters |
|---|---|---|
get_reservation_financials | Financial breakdown for a reservation | reservationId (required) |
get_revenue_summary | Aggregated revenue across listings | dateFrom, dateTo (required), listingId |
get_payout_report | Payout report for reconciliation | dateFrom, dateTo (required), channelId |
Conversations
| Tool | Description | Key Parameters |
|---|---|---|
list_conversations | Recent guest conversations | listingId, limit, unreadOnly |
get_conversation | Full message thread | conversationId (required) |
send_message | Send message to guest | conversationId, message (required) |
Read-Only Mode
Set HOSTAWAY_READ_ONLY=true to disable all write/mutation tools. When enabled, the following tools will return an error instead of executing:
update_reservation_host_notecreate_calendar_blockdelete_calendar_blocksend_message
This is useful for shared accounts or when you want to prevent accidental modifications.
Environment Variables
| Variable | Required | Description |
|---|---|---|
HOSTAWAY_ACCOUNT_ID | Yes | Your Hostaway account ID (integer) |
HOSTAWAY_CLIENT_SECRET | Yes | Your Hostaway API client secret |
HOSTAWAY_READ_ONLY | No | Set to true to disable write operations |
HOSTAWAY_CACHE_TTL | No | Token cache TTL in seconds (default: 240) |
Example Queries
Once connected, try asking Claude:
- "Show me all upcoming reservations"
- "What's the occupancy looking like for my properties next month?"
- "Find gap nights across all listings for the next 90 days"
- "How much revenue did I make last month?"
- "Show me unread guest messages"
- "What are the financials for reservation 12345?"
- "Generate a payout report for Airbnb bookings in March"
Contributing
Feedback and pull requests are welcome! Please open an issue on GitHub or email matt@plux.com.
License
MIT
الأسئلة الشائعة
ما هو io.github.mattlong-plux/hostaway؟
Hostaway PMS: reservations, listings, calendars, financials, and guest messaging.
كيف أثبّت io.github.mattlong-plux/hostaway؟
يعمل على جهازك. في Claude Code: claude mcp add hostaway -e 'HOSTAWAY_ACCOUNT_ID=<HOSTAWAY_ACCOUNT_ID>' -e 'HOSTAWAY_CLIENT_SECRET=<your hostaway_client_secret>' -e 'HOSTAWAY_READ_ONLY=<HOSTAWAY_READ_ONLY>' -e 'HOSTAWAY_CACHE_TTL=<HOSTAWAY_CACHE_TTL>' -- npx -y @matt-long-plux/hostaway-mcp@1.0.1. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.
هل يحتاج io.github.mattlong-plux/hostaway إلى مفتاح API؟
نعم. يتطلب HOSTAWAY_ACCOUNT_ID, HOSTAWAY_CLIENT_SECRET، وتضبطها في إعداداته.
هل io.github.mattlong-plux/hostaway مفتوح المصدر؟
شيفرته علنية على GitHub، لكن المستودع لا يعلن ترخيصًا قياسيًا.
من يصون io.github.mattlong-plux/hostaway؟
ينشره mattlong-plux. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.
من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.