grr

Overview Schema Source Related Servers Discussions Admin

chat.users.availability.patch

Updates an authenticated user's Google Chat availability by patching only the custom status field.

Instructions

Updates availability information for a human user. Only the custom_status field can be updated through this method. This method only updates the authenticated user's availability. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.users.availability [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Availability object accepting customStatus, doNotDisturbMetadata, name, state; pass it via params or whole via body_file Siblings over the same resource: get, markAsActive, markAsAway, markAsDoNotDisturb.

Input Schema

Name	Required	Description
`name`	Yes	[URL path segment] Identifier. Resource name of the user's availability. Format: `users/{user}/availability` `{user}` is the id for the Person in the People API or Admin SDK direc
`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 Availability object.
`updateMask`	No	[query parameter] Required. The list of fields to update. The only field that can be updated is `custom_status`.
`request_body`	No	Request body of type Availability: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

Name	Required	Description	Default
`name`	No
`state`	No
`customStatus`	No
`doNotDisturbMetadata`	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 Availability object."

addedInput schema / properties / request_body

Added value: +{
+  "description": "Request body of type Availability: pass it via `params` (merged into the built body) or whole via `body_file`.",
+  "properties": {
+    "customStatus": {
+      "properties": {
+        "emoji": {
+          "properties": {
+            "customEmoji": {
+              "properties": {
+                "emojiName": {
+                  "type": "string"
+                },
+                "name": {
+                  "type": "string"
+                },
+                "payload": {
+                  "type": "object"
+                },
+                "temporaryImageUri": {
+                  "type": "string"
+                },
+                "uid": {
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            },
+            "unicode": {
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "expireTime": {
+          "type": "string"
+        },
+        "text": {
+          "type": "string"
+        },
+        "ttl": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "doNotDisturbMetadata": {
+      "properties": {
+        "expirationTime": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "name": {
+      "type": "string"
+    },
+    "state": {
+      "enum": [
+        "STATE_UNSPECIFIED",
+        "ACTIVE",
+        "IDLE",
+        "AWAY",
+        "DO_NOT_DISTURB"
+      ],
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

Changed5 schema fields changedOct 26, 2026

changedInput schema / properties / name / description

Previous value: -"Identifier. Resource name of the user's availability. Format: `users/{user}/availability` `{user}` is the id for the Person in the People API or Admin SDK direc"New value: +"[URL path segment] Identifier. Resource name of the user's availability. Format: `users/{user}/availability` `{user}` is the id for the Person in the People API or Admin SDK direc"

addedInput schema / properties / name / pattern
```
Added value: +"^users/[^/]+/availability$"
```

changedInput schema / properties / updateMask / description

Previous value: -"Required. The list of fields to update. The only field that can be updated is `custom_status`."New value: +"[query parameter] Required. The list of fields to update. The only field that can be updated is `custom_status`."

addedInput schema / properties / updateMask / format
```
Added value: +"google-fieldmask"
```

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "customStatus": {
+      "properties": {
+        "emoji": {
+          "properties": {
+            "customEmoji": {
+              "properties": {
+                "emojiName": {
+                  "type": "string"
+                },
+                "name": {
+                  "type": "string"
+                },
+                "payload": {
+                  "type": "object"
+                },
+                "temporaryImageUri": {
+                  "type": "string"
+                },
+                "uid": {
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            },
+            "unicode": {
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "expireTime": {
+          "type": "string"
+        },
+        "text": {
+          "type": "string"
+        },
+        "ttl": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "doNotDisturbMetadata": {
+      "properties": {
+        "expirationTime": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "name": {
+      "type": "string"
+    },
+    "state": {
+      "enum": [
+        "STATE_UNSPECIFIED",
+        "ACTIVE",
+        "IDLE",
+        "AWAY",
+        "DO_NOT_DISTURB"
+      ],
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

First observedOct 26, 2026

TDQS

A4.4/5.0

Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses the required auth scopes, that this is an HTTP PATCH refused under --readonly safety profiles (write/destructive nature), the single-updatable-field constraint, and the self-only targeting. It doesn't cover reversibility or field-preservation semantics, keeping it just short of a 5.

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 but front-loads the core purpose and the custom_status constraint, then layers auth and mechanics. The inlined scope URLs and safety-profile text are verbose but each element carries operational value, so little is wasted.

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 7-parameter tool with full schema coverage, an output schema, and nested body objects, the description supplies everything an agent needs: auth/scope requirements, write/safety behavior, updatable-field constraint, and how to pass the body. Return-value explanation is not needed since an output schema exists.

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 adds meaning by naming the request-body fields (customStatus, doNotDisturbMetadata, name, state) and clarifying the params-vs-body_file mechanism for passing the body. It reinforces the schema's updateMask constraint rather than repeating blindly.

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 (Updates) and resource (availability information), the scope (for a human user, only the authenticated user), and a key constraint (only custom_status can be updated). It also names its siblings over the same resource, letting an agent distinguish it from get/markAsActive/markAsAway without opening the schema.

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?

Clearly explains the tool only updates the authenticated user's availability and only the custom_status field, which is strong context. However it lists the sibling methods (markAsActive, markAsAway, markAsDoNotDisturb) without explicitly routing the agent to them when those simpler state changes are desired.

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

Deploy Server