Discovery & availability

check_availability

Checks live availability for the given booking parameters, optionally for one offering. Returns available options with total prices and up to 3 alternatives when the request can't be met.

View as Markdown

Scope & access

Directory + businessRead only

Follow the credential fields below. Public discovery does not require a login; private booking operations require the indicated token.

This tool advertises idempotent behavior. If an idempotencyKey is specified, reuse it with identical arguments only when retrying that same intended action.

Parameters

These are the directory endpoint parameters. Business endpoints scope public discovery to the published business; owner calls still require businessId. Inspect tools/list on your endpoint for the exact schema.

businessIdRequired

string

businessId: a business ID from search_businesses, e.g. "biz_01j…", or the business's booking-page slug, e.g. "studio-nine"

offeringIdOptional

string

offeringId: an offering ID from list_offerings or get_business, e.g. "off_01j…"

paramsRequired

object

params: booking parameters matching the business's bookingParamsSchema from get_business

Example call

Pass this object to the MCP client's callTool method. Replace placeholders with returned IDs, saved credentials and the customer's details; use future dates appropriate to their request.

check_availability · MCP client arguments

json

{
  "name": "check_availability",
  "arguments": {
    "businessId": "<businessId>",
    "params": {
      "checkIn": "2026-11-14",
      "checkOut": "2026-11-16",
      "adults": 2
    }
  }
}

JSON schemas

Nested fields, formats, enums and constraints are included in the complete schemas. Successful data is returned in structuredContent. SDK input validation and domain errors use different error shapes.

Input schemaJSON Schema

Input JSON Schema

json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "businessId": {
      "type": "string",
      "minLength": 1,
      "description": "businessId: a business ID from search_businesses, e.g. \"biz_01j…\", or the business's booking-page slug, e.g. \"studio-nine\""
    },
    "offeringId": {
      "type": "string",
      "minLength": 1,
      "description": "offeringId: an offering ID from list_offerings or get_business, e.g. \"off_01j…\""
    },
    "params": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "description": "params: booking parameters matching the business's bookingParamsSchema from get_business"
    }
  },
  "required": [
    "businessId",
    "params"
  ]
}

Output schemaJSON Schema

Output JSON Schema

json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "available": {
      "type": "boolean"
    },
    "options": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "optionId": {
            "type": "string"
          },
          "offeringId": {
            "type": "string"
          },
          "offeringName": {
            "type": "string"
          },
          "start": {
            "type": "string"
          },
          "end": {
            "type": "string"
          },
          "total": {
            "type": "object",
            "properties": {
              "amountMinor": {
                "type": "number"
              },
              "currency": {
                "type": "string"
              },
              "formatted": {
                "type": "string"
              }
            },
            "required": [
              "amountMinor",
              "currency",
              "formatted"
            ],
            "additionalProperties": false
          },
          "bookingPageUrl": {
            "type": "string"
          }
        },
        "required": [
          "optionId",
          "offeringId",
          "offeringName",
          "start",
          "end",
          "total",
          "bookingPageUrl"
        ],
        "additionalProperties": {}
      }
    },
    "alternatives": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "optionId": {
            "type": "string"
          },
          "offeringId": {
            "type": "string"
          },
          "offeringName": {
            "type": "string"
          },
          "start": {
            "type": "string"
          },
          "end": {
            "type": "string"
          },
          "total": {
            "type": "object",
            "properties": {
              "amountMinor": {
                "type": "number"
              },
              "currency": {
                "type": "string"
              },
              "formatted": {
                "type": "string"
              }
            },
            "required": [
              "amountMinor",
              "currency",
              "formatted"
            ],
            "additionalProperties": false
          },
          "bookingPageUrl": {
            "type": "string"
          }
        },
        "required": [
          "optionId",
          "offeringId",
          "offeringName",
          "start",
          "end",
          "total",
          "bookingPageUrl"
        ],
        "additionalProperties": {}
      }
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "available",
    "options",
    "alternatives"
  ],
  "additionalProperties": {}
}

Behavior annotationsMCP

Tool annotations

json

{
  "readOnlyHint": true,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false
}

Errors & next steps

Check isError before reading a success response. Follow nextStep where supplied, and never treat a pending booking as confirmed. See Errors and retries and the booking lifecycle for recovery paths.

Back to all tools