Checkfront MCP by usefulapi
Check Checkfront availability and rates, and manage booking sessions, bookings, customers and notes.
Sollte ich dies verwenden
Qualität und Sicherheit
Befunde (3)
- LOWin checkfront_get_availability_calendar
- LOWin checkfront_add_to_booking_session
- LOWin checkfront_update_booking_status
Basierend auf einer automatisierten Analyse der Tool-Definitionen und der Einhaltung des Protokolls.
Kontextkosten
Dies ist die ungefähre Anzahl der Tokens, die jedes Mal verbraucht werden, wenn die Tools des Servers in den Kontext eines Modells geladen werden. Höhere Werte verringern die Aufmerksamkeit, die für andere Aufgaben verfügbar ist.
Installieren
Installation mit einem Klick
Fügen Sie dies Ihrer Datei `claude_desktop_config.json` hinzu:
{
"mcpServers": {
"checkfront": {
"url": "https://checkfront.usefulapi.io/mcp"
}
}
}Remote-Endpunkte
https://checkfront.usefulapi.io/mcpstreamable-httpWas es kann
Tool-Inventar
Tools (20)
🟢checkfront_get_company
Fetch the connected Checkfront account's company configuration — name, URL, plan, currency, timezone, locale and date/time formats. A cheap way to confirm the host and credentials work. Checkfront: GET /api/3.0/company.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢checkfront_list_categories
List the inventory categories (e.g. Tours, Rentals, Accommodations) with their ids, names, display order and item counts. Checkfront: GET /api/3.0/category.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢checkfront_list_items(category_id, keyword, item_id, available, start_date, ...)
List the enabled inventory items (tours, activities, rentals, rooms). With NO dates this is the plain catalogue. Pass start_date (and end_date / param quantities) to get a RATED response: per-item availability, pricing and a SLIP token — the SLIP is what checkfront_add_to_booking_session needs to book the item. Checkfront: GET /api/3.0/item.
Eingabe-Schema
{
"type": "object",
"properties": {
"category_id": {
"description": "Only items in this category.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"keyword": {
"description": "Only items whose name contains this keyword.",
"type": "string"
},
"item_id": {
"description": "Comma-separated list of item ids to filter to, e.g. 17,18.",
"type": "string"
},
"available": {
"description": "(rated) Only items with at least this many left in stock.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"start_date": {
"description": "(rated) Booking start date — YYYYMMDD, YYYY-MM-DD, or a relative date such as \"today\".",
"type": "string"
},
"end_date": {
"description": "(rated) Booking end date — YYYYMMDD, YYYY-MM-DD, or a relative date such as \"today\".",
"type": "string"
},
"date": {
"description": "(rated) Alias of start_date for same-day bookings — YYYYMMDD, YYYY-MM-DD, or a relative date such as \"today\".",
"type": "string"
},
"start_time": {
"description": "(rated) Start time, for hourly bookings.",
"type": "string"
},
"end_time": {
"description": "(rated) End time, for hourly bookings.",
"type": "string"
},
"param": {
"description": "Booking parameters (quantities) keyed by the parameter ids configured in your account, e.g. {\"adults\": 2, \"children\": 1}. Sent as param[adults]=2.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"discount_code": {
"description": "(rated) Discount code to apply to the price.",
"type": "string"
},
"rules": {
"description": "'soft' avoids date-based rule errors; 'off' disables rule checking.",
"type": "string",
"enum": [
"soft",
"off"
]
},
"packages": {
"description": "Include package options.",
"type": "boolean"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢checkfront_get_item(item_id, start_date, end_date, date, start_time, ...)
Fetch one inventory item's details. Pass start_date / end_date and param quantities (e.g. {"adults": 2}) for a RATED response with availability (rate.status, rate.available), the price breakdown and the SLIP used to book it. For parent/child grouped items, rate the CHILD item. Checkfront: GET /api/3.0/item/{item_id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The item id."
},
"start_date": {
"description": "(rated) Booking start date — YYYYMMDD, YYYY-MM-DD, or a relative date such as \"today\".",
"type": "string"
},
"end_date": {
"description": "(rated) Booking end date — YYYYMMDD, YYYY-MM-DD, or a relative date such as \"today\".",
"type": "string"
},
"date": {
"description": "(rated) Alias of start_date for same-day bookings — YYYYMMDD, YYYY-MM-DD, or a relative date such as \"today\".",
"type": "string"
},
"start_time": {
"description": "(rated) Start time, for hourly bookings.",
"type": "string"
},
"end_time": {
"description": "(rated) End time, for hourly bookings.",
"type": "string"
},
"param": {
"description": "Booking parameters (quantities) keyed by the parameter ids configured in your account, e.g. {\"adults\": 2, \"children\": 1}. Sent as param[adults]=2.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"discount_code": {
"description": "(rated) Discount code to apply to the price.",
"type": "string"
},
"rules": {
"description": "'soft' avoids date-based rule errors; 'off' disables rule checking.",
"type": "string",
"enum": [
"soft",
"off"
]
},
"packages": {
"description": "Include package options.",
"type": "boolean"
}
},
"required": [
"item_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢checkfront_get_availability_calendar(item_ids, category_id, start_date, end_date)
Day-by-day available inventory over a date range — for one item (item_ids with a single id), several items, or a whole category. Use it to answer 'which days next month still have space?'. Checkfront: GET /api/3.0/item/{item_id}/cal or GET /api/3.0/item/cal.
Eingabe-Schema
{
"type": "object",
"properties": {
"item_ids": {
"description": "Item ids. One id queries that item's calendar; several query them together.",
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"category_id": {
"description": "Instead of item ids, a category of items.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"start_date": {
"description": "Range start date — YYYYMMDD, YYYY-MM-DD, or a relative date such as \"today\".",
"type": "string"
},
"end_date": {
"description": "Range end date — YYYYMMDD, YYYY-MM-DD, or a relative date such as \"today\".",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢checkfront_list_bookings(status_id, customer_id, customer_email, start_date, end_date, ...)
List bookings, newest filters first — by status, customer, dates, item or partner. Each row has the booking code, status, totals (total, tax_total, paid_total), customer name/email, summary and date_desc. Paged (default 100/page); the response's request.pages tells you how many pages exist. Checkfront: GET /api/3.0/booking/index.
Eingabe-Schema
{
"type": "object",
"properties": {
"status_id": {
"description": "Booking status code, e.g. PEND, HOLD, PART, PAID, WAIT, STOP, VOID.",
"type": "string"
},
"customer_id": {
"description": "Only bookings for this customer id.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"customer_email": {
"description": "Only bookings for this customer email.",
"type": "string"
},
"start_date": {
"description": "Booking start (check-in) date. A date string or unix timestamp; prefix with '<' or '>' for before/after (e.g. \">2026-01-01\").",
"type": "string"
},
"end_date": {
"description": "Booking end (check-out) date. A date string or unix timestamp; prefix with '<' or '>' for before/after (e.g. \">2026-01-01\").",
"type": "string"
},
"created_date": {
"description": "Date the booking was created. A date string or unix timestamp; prefix with '<' or '>' for before/after (e.g. \">2026-01-01\").",
"type": "string"
},
"last_modified": {
"description": "Date the booking last changed — useful for 'changed since' syncs. A date string or unix timestamp; prefix with '<' or '>' for before/after (e.g. \">2026-01-01\").",
"type": "string"
},
"item_id": {
"description": "Only bookings containing this item.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"partner_id": {
"description": "Only bookings attributed to this partner account.",
"type": "string"
},
"limit": {
"description": "Bookings per page, 1-100 (default 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"page": {
"description": "Page number, starting at 1.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢checkfront_get_booking(booking_id)
Fetch extended information on one booking — status, dates, customer, form fields, line items and totals. Checkfront: GET /api/3.0/booking/{booking_id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"booking_id": {
"type": "string",
"minLength": 1,
"description": "The booking code identifying the booking, e.g. CFPP-290317."
}
},
"required": [
"booking_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢checkfront_list_booking_notes(date)
List the notes left on bookings across the account (default: the past 30 days), each with its booking code, author account id (0 = customer), date, body and whether it is private. Checkfront: GET /api/3.0/booking/notes.
Eingabe-Schema
{
"type": "object",
"properties": {
"date": {
"description": "Filter by a day (YYYY-MM-DD or ISO-8601) or a whole month (e.g. \"2026-09\").",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢checkfront_get_booking_form
Fetch the customer-details form for a booking (booking_form_ui): every field id (customer_name, customer_email, …), its label, type and whether it is required. Call this before checkfront_create_booking to know which `form` fields to send. Checkfront: GET /api/3.0/booking/form.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢checkfront_get_booking_session(session_id)
Read a booking session — the in-progress 'cart' — with its line items (keyed by line_id), dates, sub_total, tax, total and amount due. Checkfront: GET /api/3.0/booking/session.
Eingabe-Schema
{
"type": "object",
"properties": {
"session_id": {
"type": "string",
"minLength": 1,
"description": "The session_id returned by checkfront_add_to_booking_session."
}
},
"required": [
"session_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢checkfront_search_customers(customer_email, customer_name, customer_phone, customer_id)
Look up customers by exact email, full name or phone number (exact matches; non-unique fields such as name can return several). Results are in the `customers` object. Checkfront: GET /api/3.0/customer.
Eingabe-Schema
{
"type": "object",
"properties": {
"customer_email": {
"description": "Exact customer email address.",
"type": "string"
},
"customer_name": {
"description": "Exact full name.",
"type": "string"
},
"customer_phone": {
"description": "Exact phone number.",
"type": "string"
},
"customer_id": {
"description": "Customer code/id.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢checkfront_get_customer(customer_id)
Fetch one customer's contact details and their bookings (codes with created dates). Checkfront: GET /api/3.0/customer/{customer_id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"customer_id": {
"type": "string",
"minLength": 1,
"description": "The customer id (e.g. 25) or customer code."
}
},
"required": [
"customer_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢checkfront_list_events
List the date-based events that change price or availability — seasonal rates (SE), specials (SP), discounts (DC), closures (status U) — with their dates, recurrence, pricing rule and the items/categories they apply to. Checkfront: GET /api/3.0/event.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢checkfront_list_staff_accounts
List the staff (and partner) accounts on the Checkfront account — ids, names, emails, login ids and whether enabled. The account_id is what CHECKFRONT_ON_BEHALF takes. Checkfront: GET /api/3.0/account.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴checkfront_add_to_booking_session(session_id, slip, line_id, alter)
Start or modify a booking session: add one or more SLIPs (from a rated checkfront_get_item / checkfront_list_items call), replace a line with a new SLIP (line_id + slip), or alter lines (quantity, 'remove', 'optin'/'optout' for package add-ons). Holds the inventory while the session is open; NOTHING is booked until checkfront_create_booking. Returns the session_id to reuse. Checkfront: POST /api/3.0/booking/session.
Eingabe-Schema
{
"type": "object",
"properties": {
"session_id": {
"description": "Existing session to modify. Omit to start a new session.",
"type": "string"
},
"slip": {
"description": "One or more SLIP strings to add, e.g. [\"18.20171005X1-adults.1-children.0\"].",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"line_id": {
"description": "With a single slip: the session line to REPLACE with it (to change a regular item's options).",
"type": "string"
},
"alter": {
"description": "Changes keyed by line_id, e.g. {\"3\": 5, \"2.1\": \"optin\", \"1\": \"remove\"} (a number sets the quantity).",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"enum": [
"remove",
"optin",
"optout"
]
}
]
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴checkfront_end_booking_session(session_id, action)
Abandon a booking session: 'clear' empties its items, 'end' closes it. Releases the inventory it was holding; no booking is affected. Checkfront: POST /api/3.0/booking/session/clear or /booking/session/end.
Eingabe-Schema
{
"type": "object",
"properties": {
"session_id": {
"type": "string",
"minLength": 1,
"description": "The session to clear or end."
},
"action": {
"description": "'end' (default) closes the session; 'clear' empties it.",
"type": "string",
"enum": [
"clear",
"end"
]
}
},
"required": [
"session_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴checkfront_create_booking(session_id, slip, form)
Commit a booking: from a session_id (built with checkfront_add_to_booking_session) or directly from SLIPs, plus the customer form fields (see checkfront_get_booking_form for which are required — typically customer_name and customer_email). Creates a real reservation that consumes inventory and may notify the customer; change it later with checkfront_update_booking_status. Returns the new booking's ids and any invoice/payment URL. Checkfront: POST /api/3.0/booking/create.
Eingabe-Schema
{
"type": "object",
"properties": {
"session_id": {
"description": "The session holding the items to book.",
"type": "string"
},
"slip": {
"description": "Instead of a session: SLIP strings to book directly.",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"form": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
},
"description": "Customer form fields, e.g. {\"customer_name\": \"John Smith\", \"customer_email\": \"[email protected]\"}. Sent as form[customer_name]=…."
}
},
"required": [
"form"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴checkfront_update_booking_status(booking_id, status_id, notify)
Set a booking's status — e.g. confirm a pending booking (PAID/PART), put it on HOLD or WAIT(list), or cancel it (VOID/STOP). Reversible: set it back to the previous status the same way. Does NOT record a payment. Optionally triggers the account's customer notifications. Checkfront: POST /api/3.0/booking/{booking_id}/update.
Eingabe-Schema
{
"type": "object",
"properties": {
"booking_id": {
"type": "string",
"minLength": 1,
"description": "The booking code identifying the booking, e.g. CFPP-290317."
},
"status_id": {
"type": "string",
"minLength": 1,
"description": "The new status code. Defaults: PEND, HOLD, PART, PAID, WAIT, STOP, VOID (plus any custom statuses in Manage > Layout > Statuses)."
},
"notify": {
"description": "Send the account's notifications for this change (default false).",
"type": "boolean"
}
},
"required": [
"booking_id",
"status_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴checkfront_add_booking_note(booking_id, body)
Add a note to a booking, logged under the staff account the API acts on behalf of. Checkfront: POST /api/3.0/booking/{booking_id}/note.
Eingabe-Schema
{
"type": "object",
"properties": {
"booking_id": {
"type": "string",
"minLength": 1,
"description": "The booking code identifying the booking, e.g. CFPP-290317."
},
"body": {
"type": "string",
"minLength": 1,
"maxLength": 3000,
"description": "The note text, up to 3000 characters."
}
},
"required": [
"booking_id",
"body"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴checkfront_check_in_booking(booking_id, action)
Mark a guest as arrived (check in) or departed (check out). Checkfront adds a note under the acting account. VOID and cancelled bookings cannot be checked in or out. Checkfront: POST /api/3.0/booking/{booking_id}/checkin or /checkout.
Eingabe-Schema
{
"type": "object",
"properties": {
"booking_id": {
"type": "string",
"minLength": 1,
"description": "The booking code identifying the booking, e.g. CFPP-290317."
},
"action": {
"description": "'checkin' (default) or 'checkout'.",
"type": "string",
"enum": [
"checkin",
"checkout"
]
}
},
"required": [
"booking_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Community
Nachweis