Skip to main content
Glama

chat.users.availability.markAsDoNotDisturb

Sets the authenticated user's Google Chat availability to DO_NOT_DISTURB until a specified expiration time, preventing notifications during focused or off-hours work.

Instructions

Marks user as DO_NOT_DISTURB in Google Chat. Sets a user's availability state to DO_NOT_DISTURB until a specified expiration time. When in DO_NOT_DISTURB, users typically won't receive notifications. This method only updates the authenticated user's availability. Requires user authentication with authorization scope: - https://www.googleapis.com/auth/chat.users.availability [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON MarkAsDoNotDisturbRequest object accepting expireTime, ttl; pass it via params or whole via body_file Siblings over the same resource: get, markAsActive, markAsAway, patch.

Input Schema

NameRequiredDescriptionDefault
nameYes[URL path segment] Required. The resource name of the availability to mark as Do Not Disturb. Format: users/{user}/availability `{user}` is the id for the Person in the People API
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 MarkAsDoNotDisturbRequest object.
request_bodyNoRequest body of type MarkAsDoNotDisturbRequest: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
nameNo
stateNo
customStatusNo
doNotDisturbMetadataNo

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 MarkAsDoNotDisturbRequest object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type MarkAsDoNotDisturbRequest: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "properties": {
      +    "expireTime": {
      +      "type": "string"
      +    },
      +    "ttl": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed3 schema fields changed
    • changedInput schema / properties / name / description
      Previous value: -"Required. The resource name of the availability to mark as Do Not Disturb. Format: users/{user}/availability `{user}` is the id for the Person in the People API"New value: +"[URL path segment] Required. The resource name of the availability to mark as Do Not Disturb. Format: users/{user}/availability `{user}` is the id for the Person in the People API"
    • addedInput schema / properties / name / pattern
      Added value: +"^users/[^/]+/availability$"
    • 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"
      +}
  3. First observed

TDQS

A4.4/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and delivers: it discloses the mutation ([HTTP POST]), that it is refused under --readonly safety profiles, the required user-authentication scope, the response shape (API resource as JSON), and the semantic effect of DO_NOT_DISTURB. This is exactly the behavioral context an agent needs and would not otherwise have.

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 core purpose and expiration semantics are front-loaded and the sentence count is modest. A few templated lines (query/params/body_file plumbing, 'pass it via params or whole via body_file') are boilerplate that repeat schema text, but overall it is efficient.

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?

An output schema exists, so return-value explanation is not required, and the description covers purpose, auth requirements, mutation safety, and the DO_NOT_DISTURB effect. Nothing an agent needs to invoke it correctly is 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 params, body_file, and request_body fields are already documented in the schema. The description adds only marginal value by stating the body is a MarkAsDoNotDisturbRequest accepting expireTime and ttl, which the schema already conveys; the baseline 3 applies.

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 (marks) and resource (user availability in Google Chat) with the concrete target value DO_NOT_DISTURB. It explicitly enumerates the sibling operations over the same resource (get, markAsActive, markAsAway, patch), so an agent can distinguish this tool without opening any 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?

Gives clear context on when this applies: only the authenticated user's availability can be updated, and the effect (no notifications) is explained. It names sibling alternatives but does not state which condition should route to patch versus markAsAway, so routing guidance is implied rather than explicit.

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