English Français العربية

io.github.uncfreak1255-code/hostaway

السجل الرسمي أخرى

Read-only MCP server for Hostaway PMS — guest conversations, reservations, and listings

الشيفرة المصدرية التوثيق

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

NPM package hostaway-mcp
Claude Code 
claude mcp add hostaway -e 'HOSTAWAY_API_TOKEN=<your hostaway_api_token>' -- npx -y hostaway-mcp@0.2.0
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "hostaway": {
            "command": "npx",
            "args": [
                "-y",
                "hostaway-mcp@0.2.0"
            ],
            "env": {
                "HOSTAWAY_API_TOKEN": "<your hostaway_api_token>"
            }
        }
    }
}

متغيرات البيئة

  • HOSTAWAY_API_TOKEN إلزامي سري Hostaway API token used to authenticate all requests

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. hostaway-mcp
  2. V1 Goal
  3. Exact V1 Surface
  4. Local Development
  5. MCP Client Wiring
  6. Environment Variables
  7. V1 Non-Goals
  8. Source Design

hostaway-mcp

Read-only, hospitality-shaped MCP server for Hostaway.

This repo owns the operator product only: local/npm stdio, six read-only tools, no Cloudflare Worker, and no Seascape booking surface.

V1 Goal

Make Codex and Claude useful in real Hostaway workflows without hand-wiring raw API calls every time.

V1 is intentionally narrow:

  • read-only only
  • hospitality-native tools, not raw endpoint parity
  • optimized for conversation context, reservation lookup, and listing lookup

Exact V1 Surface

  • list_unread_guest_threads
  • get_conversation_context
  • get_reservation_brief
  • get_listing_brief
  • search_reservations
  • search_conversations

Local Development

npm install
npm test
npm run check
npm run build

Run the stdio server locally:

HOSTAWAY_API_TOKEN=your-token-here node dist/cli.js

Create a local npm package tarball:

npm pack

After publish, run without cloning:

npx hostaway-mcp

MCP Client Wiring

For local MCP clients, provide HOSTAWAY_API_TOKEN through the environment and spawn the published npm package over stdio.

The snippets below are pinned to the current published version:

hostaway-mcp@0.2.0

Update that version intentionally when you upgrade.

Claude Desktop (macOS)

Edit ~/Library/Application Support/Claude/claude_desktop_config.json.

If you already have top-level keys like preferences, keep them and add mcpServers alongside them:

{
  "mcpServers": {
    "hostaway": {
      "command": "npx",
      "args": ["-y", "hostaway-mcp@0.2.0"],
      "env": {
        "HOSTAWAY_API_TOKEN": "your-token-here"
      }
    }
  }
}

Restart Claude Desktop after saving the file.

Codex

Edit ~/.codex/config.toml and add:

[mcp_servers.hostaway]
command = "npx"
args = ["-y", "hostaway-mcp@0.2.0"]

[mcp_servers.hostaway.env]
HOSTAWAY_API_TOKEN = "your-token-here"

Verify the server is registered:

codex mcp list
Local Built CLI

If you want to run the repo checkout instead of npm, point the client at the built CLI directly:

{
  "command": "node",
  "args": ["/absolute/path/to/hostaway-mcp/dist/cli.js"],
  "env": {
    "HOSTAWAY_API_TOKEN": "your-token-here"
  }
}

Environment Variables

VariableRequiredDefaultDescription
HOSTAWAY_API_TOKENYes—Hostaway API token used to authenticate all requests.
HOSTAWAY_BASE_URLNoHostaway production URLOverride the API base URL (useful for testing).

V1 Non-Goals

  • sending guest messages
  • mutating reservations or listings
  • Cloudflare Worker transport
  • Seascape booking/distribution flows
  • webhook ingestion
  • background sync pipelines
  • dashboards or owner reporting
  • generic REST-to-MCP proxy coverage

Source Design

See docs/designs/v1-readonly-hostaway-mcp.md.

الأسئلة الشائعة

ما هو io.github.uncfreak1255-code/hostaway؟

Read-only MCP server for Hostaway PMS — guest conversations, reservations, and listings

كيف أثبّت io.github.uncfreak1255-code/hostaway؟

يعمل على جهازك. في Claude Code: claude mcp add hostaway -e 'HOSTAWAY_API_TOKEN=<your hostaway_api_token>' -- npx -y hostaway-mcp@0.2.0. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج io.github.uncfreak1255-code/hostaway إلى مفتاح API؟

نعم. يتطلب HOSTAWAY_API_TOKEN، وتضبطها في إعداداته.

هل io.github.uncfreak1255-code/hostaway مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون io.github.uncfreak1255-code/hostaway؟

ينشره uncfreak1255-code. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.