Skip to main content
Glama
Google Workspace (GWS) MCP Server

Google Workspace (GWS) MCP Server

docs_batchUpdate

Destructive

Apply batch updates to a Google Doc to insert, format, replace, or permanently delete content in one request.

Instructions

Apply updates to a Google Doc (insert, format, replace, or permanently delete content).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "documentId": "<documentId>",
      "requests": "<requests>"
    },
    "name": "docs_batchUpdate"
  }
}

Input Schema

NameRequiredDescriptionDefault
requestsYesArray of update requests as JSON string
documentIdYesThe document ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.0
    • removedInput schema / additionalProperties
      Removed value: -false
  2. First observedv1.0.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, idempotentHint=false and openWorldHint=true, so the safety profile is covered. The description does add value by specifying that deletion is permanent, which goes beyond the bare destructive flag. It says nothing, however, about non-atomicity of the batch, rollback behavior, or whether partial failures leave the document in a modified state.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with the mutation scope first and the supported operation kinds in parentheses; there is no filler or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive batch mutation tool this is thin: the most important thing an agent needs—which request payload shapes are accepted in the freeform JSON string—is absent, and there is no output schema to compensate. The annotation set carries most of the behavioral weight, so the definition is adequate but not complete.

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% for both parameters, so documentId and the requests JSON-string array are already documented structurally. The description adds no meaning beyond the schema—notably it never clarifies what request object types are valid inside the JSON string, which is the real semantic gap.

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 ('Apply updates') and resource ('a Google Doc'), and the parenthetical enumerates the operation kinds (insert, format, replace, delete). The resource name cleanly separates it from sheets_batchUpdate and slides_batchUpdate, but the description never explicitly contrasts with them or with docs_create.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not-to-use guidance, no prerequisites, and no mention of alternatives such as docs_create for new documents. The enumerated update types hint at applicability but do not constitute routing guidance.

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