Skip to main content
Glama

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. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations provide only destructiveHint=true and a title, so the description carries most of the behavioral burden. It usefully discloses the audit/attribution behavior (note is logged under the acting staff account) and the underlying endpoint, but says nothing about permission requirements, what happens if booking_id is invalid, or whether the note is visible to customers.

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?

One compact sentence with the core action front-loaded, followed by an endpoint reference. The trailing API path is marginally useful for traceability but is not strictly needed for selection or invocation.

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 two-parameter, fully-documented-schema mutation with no output schema, the description covers purpose, attribution, and endpoint. It omits only secondary details such as permission prerequisites and post-call confirmation behavior.

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%, so both parameters (booking_id format example, body 1–3000 chars) are already fully documented in the schema. The description adds no parameter meaning beyond that, which is the expected baseline 3.

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 (add) and resource (note to a booking) and clarifies the attribution model — the note is logged under the staff account the API acts on behalf of. The add-versus-list distinction from the sibling checkfront_list_booking_notes is unambiguous from the verb alone.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not-to-use guidance and no named alternative. The description only implies the obvious action of adding a note, which is already conveyed by the tool name and title.

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.