Skip to main content
Glama

calendar.calendarList.update

Updates an existing calendar list entry, letting you change properties such as summary, colors, reminders, and notifications; returns the updated JSON resource.

Instructions

Updates an existing calendar on the user's calendar list [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON CalendarListEntry object accepting accessRole, autoAcceptInvitations, backgroundColor, colorId, conferenceProperties, dataOwner, defaultReminders, deleted and 13 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, insert, list, patch, watch.

Input Schema

NameRequiredDescriptionDefault
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
dry_runNoReturn the request that would be sent, without sending it.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON CalendarListEntry object.
calendarIdYes[URL path segment] Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use
request_bodyNoRequest body of type CalendarListEntry: pass it via `params` (merged into the built body) or whole via `body_file`.
colorRgbFormatNo[query parameter] Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be

Output Schema

NameRequiredDescriptionDefault
idNo
etagNo
kindNo
hiddenNo
colorIdNo
deletedNo
primaryNo
summaryNo
locationNo
selectedNo
timeZoneNo
dataOwnerNo
accessRoleNo
descriptionNo
backgroundColorNo
foregroundColorNo
summaryOverrideNo
defaultRemindersNo
conferencePropertiesNo
notificationSettingsNo
autoAcceptInvitationsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / body_file / description
      Previous value: -"Read the request body from this file ('-' for stdin) instead of building one from the parameters."New value: +"Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON CalendarListEntry object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type CalendarListEntry: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "properties": {
      +    "accessRole": {
      +      "type": "string"
      +    },
      +    "autoAcceptInvitations": {
      +      "type": "boolean"
      +    },
      +    "backgroundColor": {
      +      "type": "string"
      +    },
      +    "colorId": {
      +      "type": "string"
      +    },
      +    "conferenceProperties": {
      +      "properties": {
      +        "allowedConferenceSolutionTypes": {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "dataOwner": {
      +      "type": "string"
      +    },
      +    "defaultReminders": {
      +      "items": {
      +        "properties": {
      +          "method": {
      +            "type": "string"
      +          },
      +          "minutes": {
      +            "type": "integer"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "deleted": {
      +      "type": "boolean"
      +    },
      +    "description": {
      +      "type": "string"
      +    },
      +    "etag": {
      +      "type": "string"
      +    },
      +    "foregroundColor": {
      +      "type": "string"
      +    },
      +    "hidden": {
      +      "type": "boolean"
      +    },
      +    "id": {
      +      "type": "string"
      +    },
      +    "kind": {
      +      "type": "string"
      +    },
      +    "location": {
      +      "type": "string"
      +    },
      +    "notificationSettings": {
      +      "properties": {
      +        "notifications": {
      +          "items": {
      +            "properties": {
      +              "method": {
      +                "type": "string"
      +              },
      +              "type": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "primary": {
      +      "type": "boolean"
      +    },
      +    "selected": {
      +      "type": "boolean"
      +    },
      +    "summary": {
      +      "type": "string"
      +    },
      +    "summaryOverride": {
      +      "type": "string"
      +    },
      +    "timeZone": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed3 schema fields changed
    • changedInput schema / properties / calendarId / description
      Previous value: -"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use"New value: +"[URL path segment] Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use"
    • changedInput schema / properties / colorRgbFormat / description
      Previous value: -"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be"New value: +"[query parameter] Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "accessRole": {
      +      "type": "string"
      +    },
      +    "autoAcceptInvitations": {
      +      "type": "boolean"
      +    },
      +    "backgroundColor": {
      +      "type": "string"
      +    },
      +    "colorId": {
      +      "type": "string"
      +    },
      +    "conferenceProperties": {
      +      "properties": {
      +        "allowedConferenceSolutionTypes": {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "dataOwner": {
      +      "type": "string"
      +    },
      +    "defaultReminders": {
      +      "items": {
      +        "properties": {
      +          "method": {
      +            "type": "string"
      +          },
      +          "minutes": {
      +            "type": "integer"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "deleted": {
      +      "type": "boolean"
      +    },
      +    "description": {
      +      "type": "string"
      +    },
      +    "etag": {
      +      "type": "string"
      +    },
      +    "foregroundColor": {
      +      "type": "string"
      +    },
      +    "hidden": {
      +      "type": "boolean"
      +    },
      +    "id": {
      +      "type": "string"
      +    },
      +    "kind": {
      +      "type": "string"
      +    },
      +    "location": {
      +      "type": "string"
      +    },
      +    "notificationSettings": {
      +      "properties": {
      +        "notifications": {
      +          "items": {
      +            "properties": {
      +              "method": {
      +                "type": "string"
      +              },
      +              "type": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "primary": {
      +      "type": "boolean"
      +    },
      +    "selected": {
      +      "type": "boolean"
      +    },
      +    "summary": {
      +      "type": "string"
      +    },
      +    "summaryOverride": {
      +      "type": "string"
      +    },
      +    "timeZone": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A3.7/5.0
Behavior4/5

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

With no annotations at all, the description carries the full burden and does reasonably well: it discloses that this is an HTTP PUT mutation, that it is blocked under readonly safety profiles, and that it returns the API response resource as JSON. It omits permission/scope requirements and does not spell out that PUT replaces unspecified fields, but the core behavioral profile — mutation plus a hard safety gate — is stated.

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?

The most decision-relevant facts (verb, resource, PUT, readonly refusal) are front-loaded in the first clause, and the whole thing is a single compact paragraph. The long enumeration of body fields ('accessRole, autoAcceptInvitations, backgroundColor ... and 13 more') is padding that duplicates the schema and slightly bloats the middle.

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 7-parameter mutation tool with nested request body, an output schema, and 100% schema coverage, the description covers the essentials: what it mutates, that it is a PUT, that a safety profile can block it, and how the body is supplied. Missing pieces (required auth scope, replace-vs-merge semantics) are modest given how much the schema already documents.

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 baseline is 3. The description enumerates several CalendarListEntry body fields and explains that the body can be supplied via `params` or wholesale via `body_file`, but that repeats what the schema and the request_body property description already say, adding no syntax, format, or precedence detail beyond the structured data.

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?

The description gives a specific verb and resource ('Updates an existing calendar on the user's calendar list') plus the HTTP method, which is far more informative than the dotted name alone. It lists the sibling operations over the same resource (delete, get, insert, list, patch, watch), signalling awareness of alternatives, but it does not explain how 'update' differs semantically from 'patch' (full replace vs partial), so an agent still has to infer that distinction.

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?

There is one genuine usage constraint: it is 'refused under --readonly safety profiles', which tells the agent when the call will not work. Beyond that, usage is only implied by naming the sibling set; there is no explicit guidance such as 'use patch for partial edits, update for full replacement', nor any prerequisite about required scopes or ownership.

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