Skip to main content
Glama

gmail.users.settings.cse.keypairs.obliterate

Permanently deletes a client-side encryption key pair that has been disabled for over 30 days, revoking access to messages encrypted with that key.

Instructions

Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/ [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 ObliterateCseKeyPairRequest object; pass it via params or whole via body_file Siblings over the same resource: create, disable, enable, get, list.

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 requester's primary email address. To indicate the authenticated user, you can use the special value `me`.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 ObliterateCseKeyPairRequest object.
keyPairIdYes[URL path segment] The identifier of the key pair to obliterate.
request_bodyNoRequest body of type ObliterateCseKeyPairRequest: 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 ObliterateCseKeyPairRequest object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type ObliterateCseKeyPairRequest: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "type": "object"
      +}
  2. Changed3 schema fields changed
    • changedInput schema / properties / keyPairId / description
      Previous value: -"The identifier of the key pair to obliterate."New value: +"[URL path segment] The identifier of the key pair to obliterate."
    • addedInput schema / properties / userId / default
      Added value: +"me"
    • changedInput schema / properties / userId / description
      Previous value: -"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`."New value: +"[URL path segment] The requester's primary email address. To indicate the authenticated user, you can use the special value `me`."
  3. First observed

TDQS

A4.6/5.0
Behavior5/5

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

With no annotations, the description fully carries the behavioral burden: it declares irreversibility ('can't restore or decrypt any messages'), the blast radius (users and Workspace admins lose read access), an auth requirement (service account for admin-managed cases), and a readonly-safety refusal. This is exactly the consequence disclosure a mutation tool needs.

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 precondition are front-loaded in the first two sentences, which is well-structured. However, the trailing service-account sentence is garbled (broken markdown link bleeding into '[HTTP POST] — creates or triggers...'), injecting noise that interrupts an otherwise clean flow.

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?

No output schema exists, yet the description states the return (API response resource as JSON) and covers the mutation's consequences and auth, while the rich schema covers params. Nothing an agent needs to invoke this destructive tool safely is missing.

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 userId, keyPairId, params, body_file and request_body are already documented. The description only restates the body-passing mechanism (ObliterateCseKeyPairRequest via `params` or `body_file`) that the schema already spells out, adding no new semantics — baseline 3.

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 ('Deletes a client-side encryption key pair permanently and immediately') and explicitly distinguishes it from siblings by name (DisableCseKeyPair) and by the closing list (create, disable, enable, get, list). An agent can route to it without opening any schema.

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

Usage Guidelines5/5

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

Gives an explicit precondition (key pair must have been turned off for >30 days) and names the alternative action that must precede it ('To turn off a key pair, use the DisableCseKeyPair method'). This is textbook when-to-use / prerequisite routing.

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