Skip to main content
Glama

checkfront

Add a note to a booking

checkfront_add_booking_note
Destructive

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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesThe note text, up to 3000 characters.
booking_idYesThe booking code identifying the booking, e.g. CFPP-290317.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations only supply destructiveHint=true and a title, so the description carries most of the burden. It usefully discloses attribution ('logged under the staff account the API acts on behalf of') and the underlying endpoint, but says nothing about note visibility (internal vs customer-facing), editability, or rate/permission requirements.

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?

Two tight sentences with the core purpose front-loaded and no filler. The trailing API route is mildly redundant for an agent but cheap and useful for API mapping.

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

Completeness4/5

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

For a simple 2-parameter write with a fully documented schema and no output schema, the description covers what the tool does, on whose behalf, and where it maps in the API. Only note-visibility semantics are left unspecified, which is a minor gap.

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 description coverage is 100%: booking_id is documented with a concrete example format (CFPP-290317) and body with its 1-3000 character bounds. The description adds no parameter-level detail beyond that, so the baseline of 3 applies.

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

Purpose4/5

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

States a concrete verb+resource ('Add a note to a booking') and even names the backend route (POST /api/3.0/booking/{booking_id}/note), so the operation is unambiguous. It does not explicitly contrast itself with the sibling checkfront_list_booking_notes, though the verb difference makes them easy to tell apart.

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

Usage Guidelines3/5

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

Usage is implied by the name and description (create a note on an existing booking), but there is no explicit when-to-use guidance, no prerequisites for the booking_id, and no mention of the read counterpart checkfront_list_booking_notes or of booking-creation sibling tools.

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.