Skip to main content
Glama
ghl-mcp-server-v2

ghl-mcp-server-v2

by zackscriven

ghl_calendar_update

Idempotent

Update an existing calendar by ID to change its name, availability, booking rules, team members, locations, and notifications.

Instructions

Update Calendar Update calendar by ID. Endpoint: PUT /calendars/{calendarId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "calendarId": "<calendarId>",
      "body": "<body>"
    },
    "name": "ghl_calendar_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
calendarIdYesCalendar Id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed128 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / alertEmail / description
      Added value: +"Alert email address"
    • addedInput schema / properties / body / properties / alertEmail / example
      Added value: +"alerts@example.com"
    • addedInput schema / properties / body / properties / allowBookingAfter / example
      Added value: +4
    • addedInput schema / properties / body / properties / allowBookingFor / example
      Added value: +30
    • addedInput schema / properties / body / properties / allowCancellation / description
      Added value: +"Allow cancellation of appointments"
    • addedInput schema / properties / body / properties / allowCancellation / example
      Added value: +true
    • addedInput schema / properties / body / properties / allowReschedule / description
      Added value: +"Allow rescheduling of appointments"
    • addedInput schema / properties / body / properties / allowReschedule / example
      Added value: +true
    • addedInput schema / properties / body / properties / appoinmentPerDay / example
      Added value: +8
    • addedInput schema / properties / body / properties / appoinmentPerSlot / description
      Added value: +"Deprecated: use appointmentPerSlot instead. Maximum bookings per slot (per user)"
    • addedInput schema / properties / body / properties / appoinmentPerSlot / example
      Added value: +1
    • addedInput schema / properties / body / properties / appointmentPerDay
      Added value: +{
      +  "description": "Number of appointments that can be booked for a given day",
      +  "example": 8,
      +  "type": "number"
      +}
    • addedInput schema / properties / body / properties / appointmentPerSlot
      Added value: +{
      +  "description": "Maximum bookings per slot (per user)",
      +  "example": 1,
      +  "type": "number"
      +}
    • addedInput schema / properties / body / properties / autoConfirm / description
      Added value: +"Auto-confirm appointments"
    • addedInput schema / properties / body / properties / autoConfirm / example
      Added value: +true
    • addedInput schema / properties / body / properties / availabilities / example
      Added value: +[
      +  {
      +    "date": "2023-09-24T00:00:00.000Z",
      +    "deleted": false,
      +    "hours": [
      +      {
      +        "closeHour": 17,
      +        "closeMinute": 0,
      +        "openHour": 8,
      +        "openMinute": 0
      +      }
      +    ],
      +    "id": "YWxwZHlrZmR5bnpnbHdu"
      +  }
      +]
    • addedInput schema / properties / body / properties / availabilities / items / properties / deleted / description
      Added value: +"Whether this availability is deleted"
    • addedInput schema / properties / body / properties / availabilities / items / properties / deleted / example
      Added value: +false
    • addedInput schema / properties / body / properties / availabilities / items / properties / hours / description
      Added value: +"Available hours for the date"
    • addedInput schema / properties / body / properties / availabilities / items / properties / hours / example
      Added value: +[
      +  {
      +    "closeHour": 17,
      +    "closeMinute": 0,
      +    "openHour": 8,
      +    "openMinute": 0
      +  }
      +]
    • addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / closeHour / description
      Added value: +"Closing hour (0-23)"
    • addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / closeHour / example
      Added value: +17
    • addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / closeMinute / description
      Added value: +"Closing minute (0-59)"
    • addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / closeMinute / example
      Added value: +0
    • addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / openHour / description
      Added value: +"Opening hour (0-23)"
    • addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / openHour / example
      Added value: +8
    • addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / openMinute / description
      Added value: +"Opening minute (0-59)"
    • addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / openMinute / example
      Added value: +0
    • addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / title
      Added value: +"Hour"
    • addedInput schema / properties / body / properties / availabilities / items / properties / id / example
      Added value: +"YWxwZHlrZmR5bnpnbHdu"
    • addedInput schema / properties / body / properties / availabilities / items / title
      Added value: +"UpdateAvailability"
    • addedInput schema / properties / body / properties / availabilityType / example
      Added value: +0
    • addedInput schema / properties / body / properties / calendarCoverImage / description
      Added value: +"Calendar cover image URL"
    • addedInput schema / properties / body / properties / calendarCoverImage / example
      Added value: +"https://path-to-image.com"
    • addedInput schema / properties / body / properties / consentLabel / description
      Added value: +"Consent label text"
    • addedInput schema / properties / body / properties / consentLabel / example
      Added value: +"I confirm that I want to receive content from this company using any contact information I provide."
    • addedInput schema / properties / body / properties / countAvailableDaysOnly
      Added value: +{
      +  "default": false,
      +  "description": "When true, only days with configured availability count toward the date range booking window",
      +  "example": false,
      +  "type": "boolean"
      +}
    • addedInput schema / properties / body / properties / description / description
      Added value: +"Calendar description"
    • addedInput schema / properties / body / properties / durationOptions
      Added value: +{
      +  "description": "Multiple duration options for the calendar. Bookers can select their preferred meeting length. Max 3 options. Exactly one must be marked as default.",
      +  "example": [
      +    {
      +      "duration": 15,
      +      "durationUnit": "mins",
      +      "isDefault": false,
      +      "order": 1
      +    },
      +    {
      +      "duration": 30,
      +      "durationUnit": "mins",
      +      "isDefault": true,
      +      "order": 2
      +    }
      +  ],
      +  "items": {
      +    "properties": {
      +      "duration": {
      +        "description": "Duration value in minutes",
      +        "example": 30,
      +        "type": "number"
      +      },
      +      "durationUnit": {
      +        "description": "Unit for the duration",
      +        "enum": [
      +          "mins",
      +          "hours"
      +        ],
      +        "example": "mins",
      +        "type": "string"
      +      },
      +      "isDefault": {
      +        "description": "Whether this is the default (pre-selected) duration",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "order": {
      +        "description": "Display order of the duration pill (1-based)",
      +        "example": 1,
      +        "type": "number"
      +      }
      +    },
      +    "required": [
      +      "duration",
      +      "durationUnit",
      +      "isDefault",
      +      "order"
      +    ],
      +    "title": "DurationOptionDto",
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / body / properties / enableRecurring / example
      Added value: +false
    • addedInput schema / properties / body / properties / eventColor / description
      Added value: +"Color for calendar events in hex format"
    • addedInput schema / properties / body / properties / eventColor / example
      Added value: +"#039BE5"
    • addedInput schema / properties / body / properties / eventTitle / description
      Added value: +"Title for calendar events"
    • addedInput schema / properties / body / properties / eventTitle / example
      Added value: +"{{contact.name}}"
    • addedInput schema / properties / body / properties / eventType / description
      Added value: +"Event type for round robin distribution"
    • addedInput schema / properties / body / properties / eventType / example
      Added value: +"RoundRobin_OptimizeForAvailability"
    • addedInput schema / properties / body / properties / formId / description
      Added value: +"Form ID to be used for booking"
    • addedInput schema / properties / body / properties / formId / example
      Added value: +"YlWd2wuCAZQzh2cH1fVZ"
    • addedInput schema / properties / body / properties / formSubmitRedirectURL / description
      Added value: +"Redirect URL after form submission"
    • addedInput schema / properties / body / properties / formSubmitRedirectURL / example
      Added value: +"https://example.com/thank-you"
    • addedInput schema / properties / body / properties / formSubmitThanksMessage / description
      Added value: +"Thank you message displayed after form submission"
    • addedInput schema / properties / body / properties / formSubmitThanksMessage / example
      Added value: +"Thank you for booking!"
    • addedInput schema / properties / body / properties / formSubmitType / description
      Added value: +"Action after form submission"
    • addedInput schema / properties / body / properties / formSubmitType / example
      Added value: +"ThankYouMessage"
    • addedInput schema / properties / body / properties / googleInvitationEmails / description
      Added value: +"Send Google invitation emails"
    • addedInput schema / properties / body / properties / googleInvitationEmails / example
      Added value: +true
    • addedInput schema / properties / body / properties / guestType / description
      Added value: +"Type of guest allowed"
    • addedInput schema / properties / body / properties / guestType / example
      Added value: +"count_only"
    • addedInput schema / properties / body / properties / isActive / description
      Added value: +"Whether the calendar is active"
    • addedInput schema / properties / body / properties / isActive / example
      Added value: +true
    • addedInput schema / properties / body / properties / isLivePaymentMode / description
      Added value: +"Whether payment mode is live"
    • addedInput schema / properties / body / properties / isLivePaymentMode / example
      Added value: +false
    • addedInput schema / properties / body / properties / locationConfigurations / example
      Added value: +[
      +  {
      +    "kind": "custom",
      +    "location": "https://meet.google.com/abc-def"
      +  }
      +]
    • addedInput schema / properties / body / properties / locationConfigurations / items / properties / location / example
      Added value: +"https://meet.google.com/abc-def"
    • addedInput schema / properties / body / properties / locationConfigurations / items / title
      Added value: +"LocationConfiguration"
    • changedInput schema / properties / body / properties / lookBusyConfig / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "LookBusyPercentage": {
      -        "description": "Percentage of slots that will be hidden",
      -        "type": "number"
      -      },
      -      "enabled": {
      -        "default": false,
      -        "description": "Apply Look Busy",
      -        "example": true,
      -        "type": "boolean"
      -      }
      -    },
      -    "required": [
      -      "enabled",
      -      "LookBusyPercentage"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "LookBusyPercentage": {
      +        "deprecated": true,
      +        "description": "Percentage of slots that will be hidden (deprecated, use lookBusyPercentage)",
      +        "example": 50,
      +        "type": "number"
      +      },
      +      "enabled": {
      +        "default": false,
      +        "description": "Apply Look Busy",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "lookBusyPercentage": {
      +        "description": "Percentage of slots that will be hidden",
      +        "example": 50,
      +        "type": "number"
      +      }
      +    },
      +    "required": [
      +      "enabled",
      +      "lookBusyPercentage"
      +    ],
      +    "title": "LookBusyConfiguration",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / properties / lookBusyConfig / example
      Added value: +{
      +  "enabled": true,
      +  "lookBusyPercentage": 50
      +}
    • addedInput schema / properties / body / properties / name / description
      Added value: +"Calendar name"
    • addedInput schema / properties / body / properties / notes / description
      Added value: +"Notes for the calendar"
    • addedInput schema / properties / body / properties / notes / example
      Added value: +"Please arrive 10 minutes early."
    • addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToContact / description
      Added value: +"Send notification to contact"
    • addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToContact / example
      Added value: +false
    • addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToGuest / description
      Added value: +"Send notification to guest"
    • addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToGuest / example
      Added value: +false
    • addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToSelectedUsers / description
      Added value: +"Send notification to selected users"
    • addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToSelectedUsers / example
      Added value: +false
    • addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToUser / description
      Added value: +"Send notification to user"
    • addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToUser / example
      Added value: +false
    • addedInput schema / properties / body / properties / notifications / items / title
      Added value: +"CalendarNotification"
    • addedInput schema / properties / body / properties / openHours / example
      Added value: +[
      +  {
      +    "daysOfTheWeek": [
      +      1,
      +      2,
      +      3,
      +      4,
      +      5
      +    ],
      +    "hours": [
      +      {
      +        "closeHour": 17,
      +        "closeMinute": 0,
      +        "openHour": 8,
      +        "openMinute": 0
      +      }
      +    ]
      +  }
      +]
    • addedInput schema / properties / body / properties / openHours / items / properties / daysOfTheWeek / description
      Added value: +"Days of the week (0=Sun, 6=Sat)"
    • addedInput schema / properties / body / properties / openHours / items / properties / daysOfTheWeek / example
      Added value: +[
      +  1,
      +  2,
      +  3,
      +  4,
      +  5
      +]
    • addedInput schema / properties / body / properties / openHours / items / properties / hours / description
      Added value: +"Open hours for the specified days"
    • addedInput schema / properties / body / properties / openHours / items / properties / hours / example
      Added value: +[
      +  {
      +    "closeHour": 17,
      +    "closeMinute": 0,
      +    "openHour": 8,
      +    "openMinute": 0
      +  }
      +]
    • addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / closeHour / description
      Added value: +"Closing hour (0-23)"
    • addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / closeHour / example
      Added value: +17
    • addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / closeMinute / description
      Added value: +"Closing minute (0-59)"
    • addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / closeMinute / example
      Added value: +0
    • addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / openHour / description
      Added value: +"Opening hour (0-23)"
    • addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / openHour / example
      Added value: +8
    • addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / openMinute / description
      Added value: +"Opening minute (0-59)"
    • addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / openMinute / example
      Added value: +0
    • addedInput schema / properties / body / properties / openHours / items / properties / hours / items / title
      Added value: +"Hour"
    • addedInput schema / properties / body / properties / openHours / items / title
      Added value: +"OpenHour"
    • addedInput schema / properties / body / properties / pixelId / description
      Added value: +"Facebook Pixel ID for tracking"
    • addedInput schema / properties / body / properties / pixelId / example
      Added value: +"1234567890"
    • addedInput schema / properties / body / properties / preBuffer / example
      Added value: +10
    • addedInput schema / properties / body / properties / preBufferUnit / example
      Added value: +"mins"
    • addedInput schema / properties / body / properties / recurring / allOf
      Added value: +[
      +  {
      +    "properties": {
      +      "bookingOption": {
      +        "description": "This setting contols what to do incase a recurring slot is unavailable",
      +        "enum": [
      +          "skip",
      +          "continue",
      +          "book_next"
      +        ],
      +        "example": "skip",
      +        "type": "string"
      +      },
      +      "bookingOverlapDefaultStatus": {
      +        "description": "This setting contols what to do incase a recurring slot is unavailable",
      +        "enum": [
      +          "confirmed",
      +          "new"
      +        ],
      +        "example": "confirmed",
      +        "type": "string"
      +      },
      +      "count": {
      +        "description": "Number of recurrences",
      +        "example": 4,
      +        "maximum": 24,
      +        "type": "number"
      +      },
      +      "freq": {
      +        "description": "Frequency of recurrence",
      +        "enum": [
      +          "DAILY",
      +          "WEEKLY",
      +          "MONTHLY"
      +        ],
      +        "example": "WEEKLY",
      +        "type": "string"
      +      }
      +    },
      +    "title": "Recurring",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / properties / recurring / description
      Added value: +"Recurring appointment configuration"
    • addedInput schema / properties / body / properties / recurring / example
      Added value: +{
      +  "bookingOption": "skip",
      +  "bookingOverlapDefaultStatus": "confirmed",
      +  "count": 4,
      +  "freq": "WEEKLY"
      +}
    • removedInput schema / properties / body / properties / recurring / properties
      Removed value: -{
      -  "bookingOption": {
      -    "description": "This setting contols what to do incase a recurring slot is unavailable",
      -    "enum": [
      -      "skip",
      -      "continue",
      -      "book_next"
      -    ],
      -    "type": "string"
      -  },
      -  "bookingOverlapDefaultStatus": {
      -    "description": "This setting contols what to do incase a recurring slot is unavailable",
      -    "enum": [
      -      "confirmed",
      -      "new"
      -    ],
      -    "type": "string"
      -  },
      -  "count": {
      -    "description": "Number of recurrences",
      -    "maximum": 24,
      -    "type": "number"
      -  },
      -  "freq": {
      -    "enum": [
      -      "DAILY",
      -      "WEEKLY",
      -      "MONTHLY"
      -    ],
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / body / properties / recurring / type
      Removed value: -"object"
    • addedInput schema / properties / body / properties / shouldAssignContactToTeamMember / description
      Added value: +"Assign contact to team member on booking"
    • addedInput schema / properties / body / properties / shouldAssignContactToTeamMember / example
      Added value: +true
    • addedInput schema / properties / body / properties / shouldSendAlertEmailsToAssignedMember / description
      Added value: +"Send alert emails to assigned team member"
    • addedInput schema / properties / body / properties / shouldSendAlertEmailsToAssignedMember / example
      Added value: +false
    • addedInput schema / properties / body / properties / shouldSkipAssigningContactForExisting / description
      Added value: +"Skip assigning contact if contact already exists"
    • addedInput schema / properties / body / properties / shouldSkipAssigningContactForExisting / example
      Added value: +false
    • addedInput schema / properties / body / properties / slotBuffer / example
      Added value: +15
    • addedInput schema / properties / body / properties / slotDuration / example
      Added value: +30
    • addedInput schema / properties / body / properties / slotDurationUnit / example
      Added value: +"mins"
    • addedInput schema / properties / body / properties / slotInterval / example
      Added value: +30
    • addedInput schema / properties / body / properties / slotIntervalUnit / example
      Added value: +"mins"
    • addedInput schema / properties / body / properties / slug / description
      Added value: +"Calendar slug for URL"
    • addedInput schema / properties / body / properties / stickyContact / description
      Added value: +"Enable sticky contact assignment"
    • addedInput schema / properties / body / properties / stickyContact / example
      Added value: +true
    • addedInput schema / properties / body / properties / teamMembers / example
      Added value: +[
      +  {
      +    "isPrimary": true,
      +    "priority": 0.5,
      +    "userId": "ocQHyuzHvysMo5N5VsXc"
      +  }
      +]
    • addedInput schema / properties / body / properties / teamMembers / items / properties / isPrimary / example
      Added value: +true
    • addedInput schema / properties / body / properties / teamMembers / items / properties / locationConfigurations / example
      Added value: +[
      +  {
      +    "kind": "custom",
      +    "location": "https://meet.google.com/abc-def"
      +  }
      +]
    • addedInput schema / properties / body / properties / teamMembers / items / properties / locationConfigurations / items / properties / location / example
      Added value: +"https://meet.google.com/abc-def"
    • addedInput schema / properties / body / properties / teamMembers / items / properties / locationConfigurations / items / title
      Added value: +"LocationConfiguration"
    • addedInput schema / properties / body / properties / teamMembers / items / properties / priority / description
      Added value: +"Priority of the team member for round robin"
    • addedInput schema / properties / body / properties / teamMembers / items / properties / priority / example
      Added value: +0.5
    • addedInput schema / properties / body / properties / teamMembers / items / properties / userId / description
      Added value: +"User ID of the team member"
    • addedInput schema / properties / body / properties / teamMembers / items / title
      Added value: +"TeamMember"
    • addedInput schema / properties / body / properties / widgetSlug / description
      Added value: +"Widget slug"
    • addedInput schema / properties / body / title
      Added value: +"CalendarUpdateDTO"
  2. First observedv2.0.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=true and openWorldHint=true, so the safety profile is carried by structured data. The description usefully adds the auth requirement ('OAuth scopes: calendars.write') and the PUT verb (implying replacement semantics), but it does not explain what happens to body fields omitted from the payload, how deprecated fields are handled, or anything about the response.

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?

Four short lines, front-loaded with the action, followed by endpoint and auth metadata. The only waste is the redundant title line repeating 'Update Calendar' immediately before 'Update calendar by ID.'

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

Completeness3/5

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

No output schema exists, so the description could reasonably say something about the response, and for a mutation with a deeply nested body it says nothing about how partial updates behave. Auth scope and endpoint are covered, and the exhaustive schema compensates for most of the rest, making this adequate but with clear gaps.

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 the schema itself documents identity (calendarId) and every nested body field with examples. The description adds nothing about parameter semantics beyond naming the path parameter in the endpoint template, which is the expected baseline of 3 when the schema does the heavy lifting.

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 specific verb+resource ('Update calendar by ID') and pins the exact REST endpoint (PUT /calendars/{calendarId}), so an agent knows precisely what operation is performed. It does not distinguish itself from siblings like ghl_calendar_create, ghl_calendar_get, or ghl_calendar_schedule_update, but the mutation target is unambiguous.

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 guidance on when to use this instead of ghl_calendar_create, ghl_calendar_get, or the availability/notification update siblings, and no preconditions beyond the OAuth scope. The OAuth scope line hints at required permission, but an agent gets no selection criteria.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools