Skip to main content
Glama

Check Live PMS Availability

check_availability
Read-only
Check real-time PMS calendar availability for one specific villa or suite (`unit_id`).

Directly queries the property management system adapter (WebHotelier, Avantio, HostHub, Lodgify, Hostify)
to verify whether a known unit is open for a specific date range and guest count.

When to use:
    - Use when you already have a specific `unit_id` (for example, when a traveler shifts dates or guest count on a shortlisted villa) and want a fast boolean availability check.
When NOT to use:
    - Do NOT use for initial discovery across a destination or island—use `search_properties` instead.
    - Do NOT use when you need itemized nightly pricing, cleaning fees, taxes, and cancellation policy—use `get_rate_details` instead.

Args:
    unit_id:   The unit_id from search_properties results (e.g. "n19trsyt73" or PMS unit identifier)
    check_in:  Arrival date YYYY-MM-DD
    check_out: Departure date YYYY-MM-DD
    guests:    Number of guests

Returns:
    JSON object confirming `available` (boolean), `unit_id`, `check_in`, `check_out`, `guests`, and optional `error`.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "unit_id": "<unit_id>",
      "check_in": "<check_in>",
      "check_out": "<check_out>",
      "guests": "<guests>"
    },
    "name": "check_availability"
  }
}

Input Schema

NameRequiredDescriptionDefault
guestsYesTotal number of guests staying at the property.
unit_idYesUnique property unit identifier (`unit_id` from `search_properties` or PMS unit ID).
check_inYesArrival date in ISO 8601 format (YYYY-MM-DD).
check_outYesDeparture date in ISO 8601 format (YYYY-MM-DD).

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / properties / check_in / description
      Added value: +"Arrival date in ISO 8601 format (YYYY-MM-DD)."
    • addedInput schema / properties / check_out / description
      Added value: +"Departure date in ISO 8601 format (YYYY-MM-DD)."
    • addedInput schema / properties / guests / description
      Added value: +"Total number of guests staying at the property."
    • addedInput schema / properties / unit_id / description
      Added value: +"Unique property unit identifier (`unit_id` from `search_properties` or PMS unit ID)."
  2. First observed

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, and the description adds genuinely new context: the read hits a live PMS adapter (WebHotelier, Avantio, HostHub, Lodgify, Hostify), so results are real-time and vary by backing system, and it returns a boolean plus an optional `error`. It does not cover latency, failure modes, or whether a false result is authoritative, which keeps it short of a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Strongly front-loaded: scope in sentence one, backing systems in sentence two, then labeled use/avoid/args/returns blocks that are easy to scan. The Args block partially duplicates the schema, which is minor redundancy but the only waste.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a four-required-param read-only check with a 100% documented schema and an output schema, the description covers everything an agent needs: scope, routing to alternatives, input provenance, and the shape of the response. No material gap remains.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents all four parameters including date formats. The Args section largely restates them; the only marginal addition is an example `unit_id` value and the reminder that it originates from `search_properties`. Baseline 3 is appropriate when the schema carries the semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource — real-time PMS calendar availability check for one specific unit — and names the exact identifier (`unit_id`) that scopes it. The distinction from `search_properties` (discovery) and `get_rate_details` (pricing) is explicit, so an agent can separate it from siblings without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides an explicit 'When to use' case (shortlisted villa where dates or guest count shift) and two 'When NOT to use' cases that each name the correct alternative tool and the condition that selects it. Nothing about routing is left to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources