Skip to main content
Glama
debanjanbasu

grr

by debanjanbasu
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Rust
Local

gmail.users.messages.batchModify

Modify labels and classification label values on specified Gmail messages in bulk by adding or removing label IDs and classification labels for a user.

Instructions

Modifies the labels and the Classification Label values on the specified messages. For administrators modifying messages for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.modify.restricted scope [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 BatchModifyMessagesRequest object accepting addClassificationLabels, addLabelIds, ids, removeClassificationLabelIds, removeLabelIds; pass it via params or whole via body_file Siblings over the same resource: batchDelete, delete, get, import, insert, list, modify, send, trash, untrash.

Input Schema

NameRequiredDescriptionDefault
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 BatchModifyMessagesRequest object.
request_bodyNoRequest body of type BatchModifyMessagesRequest: pass it via `params` (merged into the built body) or whole via `body_file`.

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 BatchModifyMessagesRequest object."
    • addedInput schema / properties / request_body
      Added value: +{
+  "description": "Request body of type BatchModifyMessagesRequest: pass it via `params` (merged into the built body) or whole via `body_file`.",
+  "properties": {
+    "addClassificationLabels": {
+      "items": {
+        "properties": {
+          "fields": {
+            "items": {
+              "properties": {
+                "fieldId": {
+                  "type": "string"
+                },
+                "selection": {
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            },
+            "type": "array"
+          },
+          "labelId": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "addLabelIds": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "ids": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "removeClassificationLabelIds": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "removeLabelIds": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    }
+  },
+  "type": "object"
+}
  2. Changed2 schema fields changed
    • 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."
  3. First observed

TDQS

A3.7/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does substantial work: it discloses that this is a mutating POST ('creates or triggers a change'), the exact OAuth scope and domain-wide delegation requirement for impersonation, behavior under --readonly safety profiles, and that a JSON response resource is returned. Remaining gaps (limits on ids array size, whether label IDs must pre-exist, reversibility) keep 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 mutating purpose and the auth requirement are front-loaded, and the sentence about the response and body mechanism earns its place. The bracketed tags ([HTTP POST], the em-dash clause) make it slightly dense and run-on, but there is no filler.

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?

For a mutating, nested-body tool with no annotations and no output schema, the description covers the essential behavior: mutation semantics, authorization/delegation needs, response format, and body-passing mechanism. It stops short of operational limits (max ids per request) and error conditions, which an agent would still benefit from.

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 parameters are already documented, and the description simply restates the BatchModifyMessagesRequest field names (addLabelIds, removeLabelIds, ids, addClassificationLabels, removeClassificationLabelIds). It adds the useful note about passing the body via `params` or `body_file`, but no semantics beyond the schema baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Modifies the labels and the Classification Label values on the specified messages') and makes the batch scope clear via 'specified messages' plural. It lists sibling tools but never explicitly contrasts batchModify with the single-message modify or batchDelete, so the differentiation is inferable rather than stated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives a real usage condition for the admin/delegation case ('For administrators modifying messages for users in their organization...') and flags refusal under --readonly profiles. However there is no guidance on choosing this over gmail.users.messages.modify or batchDelete beyond a bare sibling enumeration, so when-to-use is only partially implied.

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