import_musicxml
Import a MusicXML file into Dorico as a new flow via the Remote Control API. Handles file paths and prompts, returning the operation result.
Instructions
Import a MusicXML file into Dorico via the Remote Control API.
Dispatches File.Open with MusicXMLImportFilter.
Returns:
Result dictionary with success, supported, attempted,
requires_confirmation, code, path and note.
Note:
An import arrives as a new flow rather than joining the one on screen, and
Dorico may raise a player assignment prompt that waits for a person. While
that prompt is open, later commands are accepted but sit unexecuted in the
queue (docs/protocol.md, "Modal Dialogs").
To add music into the flow already open, use write_score(method="caret").
Use export_musicxml to produce the file in the first place, or
write_score(method="musicxml") to do both steps in one call.
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": {
"path": "<path>"
},
"name": "import_musicxml"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Filesystem path to the MusicXML file to open. Dorico reads it from disk, so it has to be a path Dorico can reach. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||