Begin undo group
gimp_begin_undo_groupStarts grouping image edits into one GIMP undo step so multiple changes undo together; close the group later with the matching end call.
Instructions
Start grouping the following changes to an image into ONE step of GIMP's undo history (what Ctrl+Z undoes in GIMP's UI). Close it with gimp_end_undo_group. Groups nest. If this client disconnects, its open groups are closed automatically. Grouping is not a transaction: nothing is rolled back on error (use checkpoints for that).
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": {
"image": "<image>"
},
"name": "gimp_begin_undo_group"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| image | Yes | Image id from gimp_status, e.g. 'image:1@a1b2c3d4'. | |
| label | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| depth | Yes | Undo groups this client still has open on the image (0 = none). | |
| image | Yes |