Skip to main content
Glama

chat.users.availability.markAsAway

Sets the authenticated Google Chat user's availability to AWAY, overriding activity-based status. Use it to force an away state for the current user.

Instructions

Marks user as AWAY in Google Chat. Sets the user's state to away and is not affected by the user's activity. 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 MarkAsAwayRequest object; pass it via params or whole via body_file Siblings over the same resource: get, markAsActive, markAsDoNotDisturb, patch.

Input Schema

NameRequiredDescriptionDefault
nameYes[URL path segment] Required. The resource name of the availability to mark as away. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin
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 MarkAsAwayRequest object.
request_bodyNoRequest body of type MarkAsAwayRequest: 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 MarkAsAwayRequest object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type MarkAsAwayRequest: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "type": "object"
      +}
  2. Changed3 schema fields changed
    • changedInput schema / properties / name / description
      Previous value: -"Required. The resource name of the availability to mark as away. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin "New value: +"[URL path segment] Required. The resource name of the availability to mark as away. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin "
    • 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.1/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 mutation semantics (HTTP POST), that it is refused under readonly safety profiles, the required auth scope, that the state is not affected by activity, and the response/request body type. It omits rate limits and reversibility nuances, keeping it from 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?

The purpose is front-loaded in the first sentence and the rest supports selection and invocation. It is somewhat dense, mixing prose with CLI-oriented notes (--readonly profiles, params/body_file), but nearly every clause carries information.

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?

Given an output schema exists (so return values need not be explained) and the schema documents all parameters, the description still supplies the auth scope, scope-of-effect, mutation warning, and sibling routing an agent needs. Fully sufficient, with only minor gaps like reversibility.

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 coverage is 100%, so the baseline is 3. The description adds that the body is a JSON MarkAsAwayRequest and can be passed via params or body_file, which is minor contextual value but no new meaning about the name/query parameters.

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 and resource ('Marks user as AWAY'), clarifies it sets availability state and is unaffected by user activity. It explicitly names the sibling alternatives (get, markAsActive, markAsDoNotDisturb, patch), so an agent can distinguish it without consulting other schemas.

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 scopes usage to the authenticated user only ('This method only updates the authenticated user's availability') and lists sibling operations for the same resource, giving context for choosing among them. It stops short of stating explicit when-not conditions beyond that scope restriction.

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