Skip to main content
Glama

Edit appointment details

update_appointment_details
DestructiveIdempotent

Edit an appointment's carrier, driver, and reference fields (company, contact, driver, trailer, PO, notes), in any status. Omitted or empty string fields are left unchanged; those fields can't be cleared. poNumbers, when sent, replaces the whole PO list (send [] to clear it) and wins over poReference. Doesn't change time, door, or status: use reschedule_appointment to move it and the status tools to approve, cancel, or complete it. Doesn't email the carrier; fires an appointment.updated webhook. Returns the updated appointment. Requires scope appointments:write (Scheduler role or above).

Input Schema

NameRequiredDescriptionDefault
notesNoNotes from the carrier or scheduler, visible to staff.
poNumbersNoReplaces every PO on the appointment. Send [] to clear them. Omit to leave the list alone. Wins over poReference when both are sent.
driverNameNoDriver's name.
companyNameNoCarrier company name.
contactNameNoCarrier contact person's name.
driverNotesNoInstructions for the driver.
driverPhoneNoDriver's mobile; check-in texts go here when SMS check-in is on.
poReferenceNoOne purchase order. Kept for older clients. Prefer poNumbers when the load has more than one. If both are sent, poNumbers wins. Sending only this replaces the list with this single value.
contactEmailNoCarrier contact email; confirmations and changes are emailed here.
contactPhoneNoCarrier contact phone, e.g. +1 214 555 0100.
appointmentIdYesAppointment id, from list_appointments, get_appointment, or create_appointment.
trailerNumberNoTrailer number.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / companyName / maxLength
      Added value: +200
    • addedInput schema / properties / contactName / maxLength
      Added value: +120
    • addedInput schema / properties / contactPhone / maxLength
      Added value: +40
  2. Changed2 schema fields changed
    • addedInput schema / properties / poNumbers
      Added value: +{
      +  "description": "Replaces every PO on the appointment. Send [] to clear them. Omit to leave the list alone. Wins over poReference when both are sent.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • changedInput schema / properties / poReference / description
      Previous value: -"Purchase order or load reference number."New value: +"One purchase order. Kept for older clients. Prefer poNumbers when the load has more than one. If both are sent, poNumbers wins. Sending only this replaces the list with this single value."
  3. Changed1 schema field changed
    • addedInput schema / properties / contactName
      Added value: +{
      +  "description": "Carrier contact person's name.",
      +  "type": "string"
      +}
  4. Changed10 schema fields changed
    • addedInput schema / properties / appointmentId / description
      Added value: +"Appointment id, from list_appointments, get_appointment, or create_appointment."
    • addedInput schema / properties / companyName / description
      Added value: +"Carrier company name."
    • addedInput schema / properties / contactEmail / description
      Added value: +"Carrier contact email; confirmations and changes are emailed here."
    • addedInput schema / properties / contactPhone / description
      Added value: +"Carrier contact phone, e.g. +1 214 555 0100."
    • addedInput schema / properties / driverName / description
      Added value: +"Driver's name."
    • addedInput schema / properties / driverNotes / description
      Added value: +"Instructions for the driver."
    • addedInput schema / properties / driverPhone / description
      Added value: +"Driver's mobile; check-in texts go here when SMS check-in is on."
    • addedInput schema / properties / notes / description
      Added value: +"Notes from the carrier or scheduler, visible to staff."
    • addedInput schema / properties / poReference / description
      Added value: +"Purchase order or load reference number."
    • addedInput schema / properties / trailerNumber / description
      Added value: +"Trailer number."
  5. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Beyond the annotations, the description discloses that omitted or empty fields are left unchanged, that most fields cannot be cleared, that poNumbers replaces the whole PO list and overrides poReference, that a webhook fires, that the carrier is not emailed, that the updated appointment is returned, and that appointments:write scope is required. This is rich behavioral context for a destructive mutation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is dense but front-loaded: it starts with what is edited, then gives constraints, then alternatives, side effects, return value, and permissions. Every sentence adds actionable information.

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?

For a 12-parameter mutation with no output schema, the description covers purpose, field behavior, alternatives, side effects, return value, and required scope. It gives an agent everything needed to invoke the tool correctly.

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 description coverage is 100%, so the schema already explains each parameter. The description adds meaningful semantics beyond the schema, especially around omission behavior, empty strings, poNumbers clearing and precedence over poReference.

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?

The description states a specific verb and resource — editing an appointment's carrier, driver, and reference fields — and enumerates the fields affected. It clearly distinguishes this tool from siblings like reschedule_appointment and the status tools.

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

Usage Guidelines5/5

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

It explicitly says when to use this tool versus alternatives: use reschedule_appointment to move the appointment, and the status tools to approve, cancel, or complete it. It also notes that time, door, and status are not changed here, leaving no ambiguity.

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