Skip to main content
Glama

Add booking question

create_booking_question

Add a question to an appointment type's booking form (Pro). DROPDOWN needs options. key is how the answer is stored (customFields.{key} on appointments); it defaults to the camelCased label and can't change later. isReference makes the answer a reference number, searchable in the appointments list. Added to the end of the form. Returns the new question with its id. Requires scope locations:write (Admin role).

Input Schema

NameRequiredDescriptionDefault
keyNoLetters and numbers, starting with a letter.
labelYesQuestion shown to carriers, e.g. "Seal number".
optionsNoChoices; required for DROPDOWN, ignored otherwise.
helpTextNoHint shown under the question.
requiredNoMust be answered to book. Default false.
fieldTypeYesAnswer input type. MULTI_TEXT holds a list, such as several PO numbers.
locationIdYesLocation id, from list_locations.
isReferenceNoTreat the answer as a searchable reference number.
appointmentTypeIdYesAppointment type id, from list_appointment_types (get_location_setup also lists inactive types).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / fieldType / description
      Previous value: -"Answer input type."New value: +"Answer input type. MULTI_TEXT holds a list, such as several PO numbers."
    • changedInput schema / properties / fieldType / enum
      Previous value: -[
      -  "SHORT_TEXT",
      -  "LONG_TEXT",
      -  "NUMBER",
      -  "DROPDOWN",
      -  "BOOLEAN",
      -  "DATE"
      -]New value: +[
      +  "SHORT_TEXT",
      +  "LONG_TEXT",
      +  "NUMBER",
      +  "DROPDOWN",
      +  "BOOLEAN",
      +  "DATE",
      +  "MULTI_TEXT"
      +]
  2. Changed8 schema fields changed
    • addedInput schema / properties / appointmentTypeId / description
      Added value: +"Appointment type id, from list_appointment_types (get_location_setup also lists inactive types)."
    • addedInput schema / properties / fieldType / description
      Added value: +"Answer input type."
    • addedInput schema / properties / helpText / description
      Added value: +"Hint shown under the question."
    • addedInput schema / properties / isReference / description
      Added value: +"Treat the answer as a searchable reference number."
    • addedInput schema / properties / label / description
      Added value: +"Question shown to carriers, e.g. \"Seal number\"."
    • addedInput schema / properties / locationId / description
      Added value: +"Location id, from list_locations."
    • addedInput schema / properties / options / description
      Added value: +"Choices; required for DROPDOWN, ignored otherwise."
    • addedInput schema / properties / required / description
      Added value: +"Must be answered to book. Default false."
  3. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Adds real behavior beyond the annotations: key is immutable once set, defaults to the camelCased label, answers land at customFields.{key}, new questions append to the end of the form, and the call returns the new question with its id. The non-idempotent and administrative nature is clear. Missing only failure behavior (e.g. duplicate key handling, plan-limit errors).

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?

Dense and front-loaded — capability first, then parameter rules, then return and permissions. The telegraphic sentence fragments are efficient but a shade harder to parse than flowing prose.

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?

Nine parameters, four required, a mutation with no output schema — the description covers prerequisites, defaults, immutability, side effects, and the return value. Nothing an agent needs before calling it is missing.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3; the description still adds meaning the schema lacks, notably how key is derived and stored, and what isReference actually enables in the appointments list. It restates a couple of schema points (DROPDOWN options) rather than extending them.

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 ('Add a question to an appointment type's booking form') and implicitly separates it from update_booking_question / delete_booking_question by describing creation only. An agent can tell exactly what gets created and where it lands.

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

Usage Guidelines4/5

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

Gives concrete preconditions: Pro plan, scope locations:write with Admin role, and the DROPDOWN-needs-options rule. It does not explicitly route the agent to update_booking_question when the question already exists, so the alternative-selection guidance is incomplete.

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