plugin_state
Export a VST instrument slot’s saved state from a closed Dorico project or replace it from a .vstpreset, with validation and backup.
Instructions
Export or replace the saved state of a VST instrument slot in a closed project.
Returns:
Result dictionary with the slot, the preset file and, for import, the backup.
Note:
Sets what a plugin holds (programs, instruments on channels) without its
window, which no assistant can operate. Import refuses a preset made for
another plugin and a project Dorico has open, writes a backup next to the
project first and tests the rewritten file. It needs ``confirm=True``. Whether
the project is open comes from Dorico's application log; without one the import
is refused unless ``dorico_closed=True``.
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": {
"action": "<action>",
"path": "<path>",
"slot": "<slot>",
"preset_path": "<preset_path>"
},
"name": "plugin_state"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | A saved .dorico project. | |
| slot | Yes | Slot as Dorico's window numbers it. | |
| action | Yes | export a slot's saved state as .vstpreset, or import one. | |
| confirm | No | True authorises a change that discards work or cannot be undone. | |
| preset_path | Yes | The .vstpreset file to write or read. | |
| dorico_closed | No | import: True states that Dorico does not have the project open; needed only where Dorico's application log cannot be read. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||