preview_test_edit
Shows diff preview.
Shows diff preview.
Read-only · Calls external systems. Safe to call: this tool does not modify data.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
actions | string | No | JSON array of actions (replaces current actions) |
auto_correct_kinds | boolean | No | Rewrite declared input_variable kinds to match the platform's variable types. Default false: kind mismatches are hard errors. |
description | string | No | New test description (only if explicitly changing it) |
name | string | No | New test name (only if explicitly changing it) |
skip_validation | boolean | No | Bypass the client-side validator (the platform still validates). Use for action types the CLI doesn't recognise or top-level metadata edits. Match this to the edit_test call you are previewing so the preview and apply run the same path. |
test_id | number | Yes | ID of the test to preview changes for |
variables | string | No | JSON variables object (replaces current variables) |
variants | array | No | Variant pin specifiers for V3 bucket resolution. Each item is '5' (numeric ID) or 'API:Staging' (group:variant by name). Edit mode: groups not pinned retain their existing buckets. |
Example arguments
Illustrative arguments an agent supplies when calling this tool:
{
"test_id": 0
}Description
Protected fields (cannot change): product_id, collection_uid.
Preview the impact of editing a test WITHOUT applying changes. Returns which tests would be invalidated and which monitorings would be deactivated.
V3 buckets: pass variants=["API:Staging", ...] (repeatable, same forms as create_test) to preview re-pinning. In edit mode, groups not pinned retain their existing buckets. Pre-V3 tests get default variants filled in automatically.
Workflow: get_full_test → preview_test_edit → (review impact) → edit_test.Related
What's next?
Last updated on