grr

Overview Schema Source Related Servers Discussions Admin

gmail.users.settings.updateAutoForwarding

Updates the auto-forwarding setting for a Gmail account, letting you enable forwarding, choose a disposition, and set the verified forwarding address. Use it to change where incoming mail is sent.

Instructions

Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. For more information, see Manage email forwarding. This method is only available to service account clients that have been delegated domain-wide authority [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON AutoForwarding object accepting disposition, emailAddress, enabled; pass it via params or whole via body_file Siblings over the same resource: getAutoForwarding, getImap, getLanguage, getPop, getVacation, updateImap, updateLanguage, updatePop, updateVacation.

Input Schema

Name	Required	Description	Default
`query`	No	Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
`params`	No	Parameter map merged into the request; typed parameters win.
`userId`	Yes	[URL path segment] User's email address. The special value "me" can be used to indicate the authenticated user.	me
`dry_run`	No	Return the request that would be sent, without sending it.
`body_file`	No	Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON AutoForwarding object.
`request_body`	No	Request body of type AutoForwarding: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

Name	Required	Description	Default
`enabled`	No
`disposition`	No
`emailAddress`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedOct 26, 2026

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 AutoForwarding object."

addedInput schema / properties / request_body

Added value: +{
+  "description": "Request body of type AutoForwarding: pass it via `params` (merged into the built body) or whole via `body_file`.",
+  "properties": {
+    "disposition": {
+      "enum": [
+        "dispositionUnspecified",
+        "leaveInInbox",
+        "archive",
+        "trash",
+        "markRead"
+      ],
+      "type": "string"
+    },
+    "emailAddress": {
+      "type": "string"
+    },
+    "enabled": {
+      "type": "boolean"
+    }
+  },
+  "type": "object"
+}

Changed3 schema fields changedOct 26, 2026

addedInput schema / properties / userId / default
```
Added value: +"me"
```

changedInput schema / properties / userId / description

Previous value: -"User's email address. The special value \"me\" can be used to indicate the authenticated user."New value: +"[URL path segment] User's email address. The special value \"me\" can be used to indicate the authenticated user."

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "disposition": {
+      "enum": [
+        "dispositionUnspecified",
+        "leaveInInbox",
+        "archive",
+        "trash",
+        "markRead"
+      ],
+      "type": "string"
+    },
+    "emailAddress": {
+      "type": "string"
+    },
+    "enabled": {
+      "type": "boolean"
+    }
+  },
+  "type": "object"
+}

First observedOct 26, 2026

TDQS

A4.6/5.0

Behavior5/5

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

With no annotations provided, the description carries the full burden and does so well: it declares this is a mutating HTTP PUT, notes it is 'refused under --readonly safety profiles,' states the domain-wide delegation auth requirement, and discloses the return shape. For a mutation tool these are exactly the traits an agent needs before calling.

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 prerequisites are front-loaded and each sentence is relevant. It is slightly padded by wrapper boilerplate ('Returns the API's response resource as JSON', '[HTTP PUT]') and the long sibling enumeration, but nothing is truly wasted.

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?

The output schema is present, so return values needn't be spelled out, yet the description still notes the JSON response. Combined with auth requirements, forwarding-address prerequisite, body construction options, and sibling routing, an agent has everything needed to call this correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents all six parameters and the AutoForwarding fields. The description still adds value by naming the body fields (disposition, emailAddress, enabled) as a single object and clarifying the two delivery paths ('pass it via params or whole via body_file').

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 gives a specific verb and resource ('Updates the auto-forwarding setting') and scopes it to 'the specified account.' It then names the sibling getters/setters over the same resource, so the agent can place this tool precisely within the forwarding-settings cluster without opening a 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?

It supplies real usage preconditions: 'A verified forwarding address must be specified when auto-forwarding is enabled' and 'only available to service account clients that have been delegated domain-wide authority.' Naming the sibling update*/get* methods implies the read-vs-write split, though it never explicitly says 'use getAutoForwarding to read before updating.'

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server