illustrator_get_document
Retrieves complete Illustrator document structure as a JSON tree, including layers, items, positions, and properties, to inspect canvas state before writing modification scripts.
Instructions
Get complete document information and structure as a JSON tree.
CONTRACT: readOnly=True, destructive=False, idempotent=True, openWorld=False
WHEN TO USE:
Understanding canvas state before writing modification scripts
Inspecting layers, items, positions, and properties
Getting Illustrator application info (scope='app')
OPTIONS: scope: 'document' (default), 'app', or 'both' max_items: items per layer, 1-5000 (default 200) max_layers: layers to return, 1-200 (default 50) offset: skip first N items per layer (for paging) layer_name / layer_index: filter to single layer
EXAMPLES: illustrator_get_document() illustrator_get_document(scope="app") illustrator_get_document(layer_name="Layer 1", offset=200, max_items=200)
NOTES:
If a layer is truncated, response includes truncated=true and nextOffset
scope='both' returns {document: {...}, app: {...}}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |