grr

Overview Schema Source Related Servers Discussions Admin

calendar.calendarList.patch

Updates selected fields of an existing calendar entry in the user's calendar list using patch semantics; use it to change color, reminders, visibility, or other settings without replacing the full entry.

Instructions

Updates an existing calendar on the user's calendar list. This method supports patch semantics [HTTP PATCH] — 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, update, watch.

Input Schema

Name	Required	Description
`query`	No	Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
`params`	No	Parameter map merged into the request; typed parameters win.
`dry_run`	No	Return the request that would be sent, without sending it.
`body_file`	No	Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON CalendarListEntry object.
`calendarId`	Yes	[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_body`	No	Request body of type CalendarListEntry: pass it via `params` (merged into the built body) or whole via `body_file`.
`colorRgbFormat`	No	[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

Name	Required	Description	Default
`id`	No
`etag`	No
`kind`	No
`hidden`	No
`colorId`	No
`deleted`	No
`primary`	No
`summary`	No
`location`	No
`selected`	No
`timeZone`	No
`dataOwner`	No
`accessRole`	No
`description`	No
`backgroundColor`	No
`foregroundColor`	No
`summaryOverride`	No
`defaultReminders`	No
`conferenceProperties`	No
`notificationSettings`	No
`autoAcceptInvitations`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedOct 26, 2026

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"
+}

Changed3 schema fields changedOct 26, 2026

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"
+}

First observedOct 26, 2026

TDQS

B3.4/5.0

Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose two useful traits: patch semantics (unspecified fields are not replaced) and that the call is refused under --readonly safety profiles. It does not state permission/auth requirements, whether the change is reversible, or side effects on the user's other calendar lists, which matter for an unannotated mutation tool.

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

Conciseness3/5

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

Front-loaded with the action and the safety-profile caveat, which is good. But the middle clause listing nine body fields plus 'and 13 more' is padding that duplicates the request_body schema and crowds out more useful information such as permission requirements.

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?

An output schema exists, so the brief mention that the API response resource is returned as JSON is sufficient. For a seven-parameter mutation with nested body, no annotations and a fully described schema, the coverage is nearly adequate; only auth/permission prerequisites and the patch-vs-update rule are missing.

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 already documents calendarId, colorRgbFormat, params, body_file and the full CalendarListEntry body. The description's field enumeration ('accessRole, autoAcceptInvitations, backgroundColor, ... and 13 more') and the 'pass it via params or whole via body_file' note restate what the schema already says, adding little new meaning.

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 and resource ('Updates an existing calendar on the user's calendar list') and explicitly frames it as PATCH semantics rather than full replacement. It lists the sibling operations over the same resource (delete, get, insert, list, update, watch) but never actually distinguishes patch from calendar.calendarList.update, so the differentiation is enumerated rather than explained.

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?

Usage is only implied: 'supports patch semantics' hints that partial updates are intended, but there is no explicit statement of when to prefer this over calendar.calendarList.update (full replace) or insert. The one concrete conditional, 'refused under --readonly safety profiles,' is about environment safety rather than task selection.

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

Deploy Server