Skip to main content
Glama

gmail.users.settings.sendAs.patch

Update selected settings of a Gmail send-as alias, such as display name, signature, reply-to address, or default status, without replacing the full alias configuration.

Instructions

Patch the specified send-as alias. For more information, see Manage aliases and signatures with the Gmail API [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SendAs object accepting displayName, isDefault, isPrimary, replyToAddress, sendAsEmail, signature, smtpMsa, treatAsAlias and 1 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list, update, verify.

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] 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 SendAs object.
sendAsEmailYes[URL path segment] The send-as alias to be updated.
request_bodyNoRequest body of type SendAs: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
smtpMsaNo
isDefaultNo
isPrimaryNo
signatureNo
displayNameNo
sendAsEmailNo
treatAsAliasNo
replyToAddressNo
verificationStatusNo

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 SendAs object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type SendAs: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "properties": {
      +    "displayName": {
      +      "type": "string"
      +    },
      +    "isDefault": {
      +      "type": "boolean"
      +    },
      +    "isPrimary": {
      +      "type": "boolean"
      +    },
      +    "replyToAddress": {
      +      "type": "string"
      +    },
      +    "sendAsEmail": {
      +      "type": "string"
      +    },
      +    "signature": {
      +      "type": "string"
      +    },
      +    "smtpMsa": {
      +      "properties": {
      +        "host": {
      +          "type": "string"
      +        },
      +        "password": {
      +          "type": "string"
      +        },
      +        "port": {
      +          "type": "integer"
      +        },
      +        "securityMode": {
      +          "enum": [
      +            "securityModeUnspecified",
      +            "none",
      +            "ssl",
      +            "starttls"
      +          ],
      +          "type": "string"
      +        },
      +        "username": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "treatAsAlias": {
      +      "type": "boolean"
      +    },
      +    "verificationStatus": {
      +      "enum": [
      +        "verificationStatusUnspecified",
      +        "accepted",
      +        "pending"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed4 schema fields changed
    • changedInput schema / properties / sendAsEmail / description
      Previous value: -"The send-as alias to be updated."New value: +"[URL path segment] The send-as alias to be updated."
    • 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": {
      +    "displayName": {
      +      "type": "string"
      +    },
      +    "isDefault": {
      +      "type": "boolean"
      +    },
      +    "isPrimary": {
      +      "type": "boolean"
      +    },
      +    "replyToAddress": {
      +      "type": "string"
      +    },
      +    "sendAsEmail": {
      +      "type": "string"
      +    },
      +    "signature": {
      +      "type": "string"
      +    },
      +    "smtpMsa": {
      +      "properties": {
      +        "host": {
      +          "type": "string"
      +        },
      +        "password": {
      +          "type": "string"
      +        },
      +        "port": {
      +          "type": "integer"
      +        },
      +        "securityMode": {
      +          "enum": [
      +            "securityModeUnspecified",
      +            "none",
      +            "ssl",
      +            "starttls"
      +          ],
      +          "type": "string"
      +        },
      +        "username": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "treatAsAlias": {
      +      "type": "boolean"
      +    },
      +    "verificationStatus": {
      +      "enum": [
      +        "verificationStatusUnspecified",
      +        "accepted",
      +        "pending"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  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 reasonably well: it identifies this as an HTTP PATCH mutation, notes read-only profile refusal, states that the response is JSON, and explains body delivery via `params` or `body_file`. It still omits permission/auth requirements and the precise effect of partial updates on unspecified fields.

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 description is dense but front-loads the core purpose and then adds safety, return, body, and sibling context. Most sentences earn their place, though the documentation link and sibling list add some bulk.

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 a rich schema with 100% description coverage and an output schema, the description supplies the key missing behavioral context: mutation safety refusal, return format, and body construction alternatives. The main remaining gap is authorization or domain-permission requirements for changing send-as settings.

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 baseline is 3. The description reiterates the SendAs body fields and mentions `params`/`body_file`, but adds little syntax or meaning beyond what the rich input schema already provides.

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?

The description uses a specific verb ("Patch") and resource ("send-as alias") and names the sibling operations on the same resource. It does not explain how this differs semantically from `update`, but the operation and target are still unambiguous.

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 discloses that the call is refused under `--readonly` safety profiles and lists sibling tools, but it does not explicitly say when to choose patch versus update, verify, or create. Usage is implied by the PATCH verb rather than stated with selection criteria.

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