Skip to main content
Glama
debanjanbasu

grr

by debanjanbasu
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Rust
Local

forms.forms.batchUpdate

Apply multiple changes to a Google Form in one batch request, including adding, updating, or deleting items and adjusting form info or settings.

Instructions

Change the form with a batch of updates [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 BatchUpdateFormRequest object accepting includeFormInResponse, requests, writeControl; pass it via params or whole via body_file Siblings over the same resource: create, get, setPublishSettings.

Input Schema

NameRequiredDescriptionDefault
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
formIdYes[URL path segment] Required. The form ID.
paramsNoParameter map merged into the request; typed parameters win.
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 BatchUpdateFormRequest object.
request_bodyNoRequest body of type BatchUpdateFormRequest: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
formNo
repliesNo
writeControlNo

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 BatchUpdateFormRequest object."
    • addedInput schema / properties / request_body
      Added value: +{
+  "description": "Request body of type BatchUpdateFormRequest: pass it via `params` (merged into the built body) or whole via `body_file`.",
+  "properties": {
+    "includeFormInResponse": {
+      "type": "boolean"
+    },
+    "requests": {
+      "items": {
+        "properties": {
+          "createItem": {
+            "properties": {
+              "item": {
+                "properties": {
+                  "description": {
+                    "type": "string"
+                  },
+                  "imageItem": {
+                    "type": "object"
+                  },
+                  "itemId": {
+                    "type": "string"
+                  },
+                  "pageBreakItem": {
+                    "type": "object"
+                  },
+                  "questionGroupItem": {
+                    "type": "object"
+                  },
+                  "questionItem": {
+                    "type": "object"
+                  },
+                  "textItem": {
+                    "type": "object"
+                  },
+                  "title": {
+                    "type": "string"
+                  },
+                  "videoItem": {
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "location": {
+                "properties": {
+                  "index": {
+                    "type": "integer"
+                  }
+                },
+                "type": "object"
+              }
+            },
+            "type": "object"
+          },
+          "deleteItem": {
+            "properties": {
+              "location": {
+                "properties": {
+                  "index": {
+                    "type": "integer"
+                  }
+                },
+                "type": "object"
+              }
+            },
+            "type": "object"
+          },
+          "moveItem": {
+            "properties": {
+              "newLocation": {
+                "properties": {
+                  "index": {
+                    "type": "integer"
+                  }
+                },
+                "type": "object"
+              },
+              "originalLocation": {
+                "properties": {
+                  "index": {
+                    "type": "integer"
+                  }
+                },
+                "type": "object"
+              }
+            },
+            "type": "object"
+          },
+          "updateFormInfo": {
+            "properties": {
+              "info": {
+                "properties": {
+                  "description": {
+                    "type": "string"
+                  },
+                  "documentTitle": {
+                    "type": "string"
+                  },
+                  "title": {
+                    "type": "string"
+                  }
+                },
+                "type": "object"
+              },
+              "updateMask": {
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "updateItem": {
+            "properties": {
+              "item": {
+                "properties": {
+                  "description": {
+                    "type": "string"
+                  },
+                  "imageItem": {
+                    "type": "object"
+                  },
+                  "itemId": {
+                    "type": "string"
+                  },
+                  "pageBreakItem": {
+                    "type": "object"
+                  },
+                  "questionGroupItem": {
+                    "type": "object"
+                  },
+                  "questionItem": {
+                    "type": "object"
+                  },
+                  "textItem": {
+                    "type": "object"
+                  },
+                  "title": {
+                    "type": "string"
+                  },
+                  "videoItem": {
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "location": {
+                "properties": {
+                  "index": {
+                    "type": "integer"
+                  }
+                },
+                "type": "object"
+              },
+              "updateMask": {
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "updateSettings": {
+            "properties": {
+              "settings": {
+                "properties": {
+                  "emailCollectionType": {
+                    "enum": [
+                      "EMAIL_COLLECTION_TYPE_UNSPECIFIED",
+                      "DO_NOT_COLLECT",
+                      "VERIFIED",
+                      "RESPONDER_INPUT"
+                    ],
+                    "type": "string"
+                  },
+                  "quizSettings": {
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "updateMask": {
+                "type": "string"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "writeControl": {
+      "properties": {
+        "requiredRevisionId": {
+          "type": "string"
+        },
+        "targetRevisionId": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  2. Changed2 schema fields changed
    • changedInput schema / properties / formId / description
      Previous value: -"Required. The form ID."New value: +"[URL path segment] Required. The form ID."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "form": {
+      "properties": {
+        "formId": {
+          "type": "string"
+        },
+        "info": {
+          "properties": {
+            "description": {
+              "type": "string"
+            },
+            "documentTitle": {
+              "type": "string"
+            },
+            "title": {
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "items": {
+          "items": {
+            "properties": {
+              "description": {
+                "type": "string"
+              },
+              "imageItem": {
+                "properties": {
+                  "image": {
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "itemId": {
+                "type": "string"
+              },
+              "pageBreakItem": {
+                "type": "object"
+              },
+              "questionGroupItem": {
+                "properties": {
+                  "grid": {
+                    "type": "object"
+                  },
+                  "image": {
+                    "type": "object"
+                  },
+                  "questions": {
+                    "items": {
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                },
+                "type": "object"
+              },
+              "questionItem": {
+                "properties": {
+                  "image": {
+                    "type": "object"
+                  },
+                  "question": {
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "textItem": {
+                "type": "object"
+              },
+              "title": {
+                "type": "string"
+              },
+              "videoItem": {
+                "properties": {
+                  "caption": {
+                    "type": "string"
+                  },
+                  "video": {
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "linkedSheetId": {
+          "type": "string"
+        },
+        "publishSettings": {
+          "properties": {
+            "publishState": {
+              "properties": {
+                "isAcceptingResponses": {
+                  "type": "boolean"
+                },
+                "isPublished": {
+                  "type": "boolean"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "responderUri": {
+          "type": "string"
+        },
+        "revisionId": {
+          "type": "string"
+        },
+        "settings": {
+          "properties": {
+            "emailCollectionType": {
+              "enum": [
+                "EMAIL_COLLECTION_TYPE_UNSPECIFIED",
+                "DO_NOT_COLLECT",
+                "VERIFIED",
+                "RESPONDER_INPUT"
+              ],
+              "type": "string"
+            },
+            "quizSettings": {
+              "properties": {
+                "isQuiz": {
+                  "type": "boolean"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "replies": {
+      "items": {
+        "properties": {
+          "createItem": {
+            "properties": {
+              "itemId": {
+                "type": "string"
+              },
+              "questionId": {
+                "items": {
+                  "type": "string"
+                },
+                "type": "array"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "writeControl": {
+      "properties": {
+        "requiredRevisionId": {
+          "type": "string"
+        },
+        "targetRevisionId": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "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 full burden and does well: it discloses that the call mutates ('creates or triggers a change'), that it is blocked under --readonly safety profiles, and that it returns the API response resource as JSON. It does not mention that batch requests can delete form items or describe ordering/atomicity behavior of the batch, which would matter for a destructive-capable tool.

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?

Front-loaded with the action and safety caveat, then the return/body contract, then sibling routing. Dense but every clause carries information; the only mild cost is a long run-on middle sentence mixing return value and request format.

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 mutation tool with rich nested schema and an output schema, the description supplies the missing pieces: it is a write, it is refused in readonly profiles, and how to supply the body. Batch semantics (that individual requests include deleteItem/moveItem and may be partially destructive) are left entirely to the schema.

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 schema already documents formId, params, body_file, dry_run, and the nested BatchUpdateFormRequest. The description only restates the body routing ('pass it via params or whole via body_file') and the three top-level body fields — useful reinforcement but not new meaning beyond the schema.

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 + resource + mechanism: 'Change the form with a batch of updates', and notes it is an HTTP POST mutation. It names the sibling tools over the same resource (create, get, setPublishSettings), so the agent can place it. It stops short of saying which sub-operations the batch supports (add/move/delete/update items, form info, settings), which the schema carries.

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?

The sibling list at the end implies routing (read with get, create with create), and 'refused under --readonly safety profiles' tells the agent when this call will fail. But there is no explicit 'use this instead of X when Y' condition and no prerequisites stated, leaving selection to inference from the name alone.

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