Skip to main content
Glama

chat.users.availability.get

Retrieves the authenticated user's Google Chat availability, including online or away state and custom status message, to check current presence before messaging.

Instructions

Returns availability information for a human user in Google Chat. For example, this can be used to check if a user is online or away, or to retrieve their custom status message. This method only retrieves the authenticated user's availability. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.users.availability.readonly - https://www.googleapis.com/auth/chat.us [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the paramsmap), or read whole frombody_file` Siblings over the same resource: markAsActive, markAsAway, markAsDoNotDisturb, patch.

Input Schema

NameRequiredDescriptionDefault
nameYes[URL path segment] Required. The resource name of the availability to retrieve. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK
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.

Output Schema

NameRequiredDescriptionDefault
nameNo
stateNo
customStatusNo
doNotDisturbMetadataNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / name / description
      Previous value: -"Required. The resource name of the availability to retrieve. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK "New value: +"[URL path segment] Required. The resource name of the availability to retrieve. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK "
    • 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"
      +}
  2. First observed

TDQS

A4/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden. It discloses that this is an HTTP GET read operation, requires user authentication, lists authorization scopes, and says the resource is returned as JSON; the remaining gaps are minor, such as rate limits or finer permission behavior beyond scopes.

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?

The purpose is front-loaded and the sibling list is useful, but the text is structurally messy: the authorization scope list is truncated into an awkward fragment ('chat.us [HTTP GET].') and generic request-body/body_file boilerplate is appended even though this is a GET retrieval. These portions reduce clarity and add noise.

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 description does not need to explain return values. It covers the key invocation context: authentication requirement, scopes, read-only GET behavior, scope limitation to the authenticated user, and sibling alternatives. The truncated scope and generic boilerplate are minor completeness blemishes rather than missing critical information.

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 all five parameters and the baseline is 3. The description adds a useful semantic constraint that only the authenticated user's availability is retrievable, but it does not add syntax or format details for the `name` parameter beyond what the schema provides.

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?

The description states a specific verb and resource: returns availability information for a human user in Google Chat. It clarifies scope with examples and the constraint that it only retrieves the authenticated user's availability, and it names sibling methods over the same resource, so an agent can distinguish it from markAsActive, markAsAway, markAsDoNotDisturb, and patch.

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?

It gives a clear usage context: checking whether a user is online, away, or has a custom status, and explicitly limits retrieval to the authenticated user's availability. It also lists sibling methods on the same resource, which helps route the agent away from this read operation when a state-changing action is intended, though it does not spell out 'use X instead when...' explicitly.

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