Skip to main content
Glama

gmail.users.labels.update

Update a Gmail label’s name, color, and visibility settings via the Gmail API; changes are refused under read-only safety profiles.

Instructions

Updates the specified label. For more information, see Manage labels [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Label object accepting color, id, labelListVisibility, messageListVisibility, messagesTotal, messagesUnread, name, threadsTotal and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list, patch.

Input Schema

NameRequiredDescriptionDefault
idYes[URL path segment] The ID of the label to update.
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
userIdYes[URL path segment] The user's email address. The special value `me` can be used to indicate the authenticated user.me
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 Label object.
request_bodyNoRequest body of type Label: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
idNo
nameNo
typeNo
colorNo
threadsTotalNo
messagesTotalNo
threadsUnreadNo
messagesUnreadNo
labelListVisibilityNo
messageListVisibilityNo

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 Label object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type Label: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "properties": {
      +    "color": {
      +      "properties": {
      +        "backgroundColor": {
      +          "type": "string"
      +        },
      +        "textColor": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "id": {
      +      "type": "string"
      +    },
      +    "labelListVisibility": {
      +      "enum": [
      +        "labelShow",
      +        "labelShowIfUnread",
      +        "labelHide"
      +      ],
      +      "type": "string"
      +    },
      +    "messageListVisibility": {
      +      "enum": [
      +        "show",
      +        "hide"
      +      ],
      +      "type": "string"
      +    },
      +    "messagesTotal": {
      +      "type": "integer"
      +    },
      +    "messagesUnread": {
      +      "type": "integer"
      +    },
      +    "name": {
      +      "type": "string"
      +    },
      +    "threadsTotal": {
      +      "type": "integer"
      +    },
      +    "threadsUnread": {
      +      "type": "integer"
      +    },
      +    "type": {
      +      "enum": [
      +        "system",
      +        "user"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed4 schema fields changed
    • changedInput schema / properties / id / description
      Previous value: -"The ID of the label to update."New value: +"[URL path segment] The ID of the label to update."
    • addedInput schema / properties / userId / default
      Added value: +"me"
    • changedInput schema / properties / userId / description
      Previous value: -"The user's email address. The special value `me` can be used to indicate the authenticated user."New value: +"[URL path segment] The user's email address. The special value `me` can be used to indicate the authenticated user."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "color": {
      +      "properties": {
      +        "backgroundColor": {
      +          "type": "string"
      +        },
      +        "textColor": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "id": {
      +      "type": "string"
      +    },
      +    "labelListVisibility": {
      +      "enum": [
      +        "labelShow",
      +        "labelShowIfUnread",
      +        "labelHide"
      +      ],
      +      "type": "string"
      +    },
      +    "messageListVisibility": {
      +      "enum": [
      +        "show",
      +        "hide"
      +      ],
      +      "type": "string"
      +    },
      +    "messagesTotal": {
      +      "type": "integer"
      +    },
      +    "messagesUnread": {
      +      "type": "integer"
      +    },
      +    "name": {
      +      "type": "string"
      +    },
      +    "threadsTotal": {
      +      "type": "integer"
      +    },
      +    "threadsUnread": {
      +      "type": "integer"
      +    },
      +    "type": {
      +      "enum": [
      +        "system",
      +        "user"
      +      ],
      +      "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 is a PUT that replaces the resource, that it is refused under --readonly safety profiles, and that the API response resource is returned as JSON. Missing are permission scopes and any warning about fields omitted from the body being cleared by the full replacement.

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?

Purpose and HTTP verb are front-loaded, and the whole definition is a single dense paragraph with no filler. The body-field enumeration and return-value clause are slightly redundant given the rich schema and output schema, costing a point.

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?

Covers mutation semantics, readonly refusal, body construction paths and sibling alternatives; the return value is already covered by the output schema, so restating it is harmless. Nothing essential for a correct call is missing, though permission requirements would round it out.

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 only the routing distinction between building the body through `params` and passing it whole via `body_file`, while the enumerated Label fields largely restate the request_body schema.

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 ("Updates the specified label") and immediately distinguishes itself from the sibling patch by declaring HTTP PUT full-replacement semantics plus an explicit sibling list (create, delete, get, list, patch). An agent can tell update from patch without opening either 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?

Names all siblings over the same resource and flags PUT/whole-resource semantics, which is the decisive signal for choosing update over patch. It stops short of saying explicitly "use patch for partial changes," so the routing guidance is strongly implied rather than stated.

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