add_rest
Inserts one rest of a specified duration at the caret in Dorico and advances the caret, leaving rest-input mode unchanged. Use goto_bar first to choose where the rest lands.
Instructions
Input one rest at the caret.
One rest at the current caret position, which then advances by that duration.
It switches rest input on, presses the rest key and switches rest input off
again, so rest mode is left as it was found. After ``goto_bar`` note input
stays on and the next call continues; otherwise it is entered and exited here.
Returns:
Result dictionary with success, the duration entered, the undo flag and the
resulting mode.
Note:
Success means Dorico accepted the command (kOK), not that the rest is where
it was wanted (docs/protocol.md, 'Command Acceptance vs Effect'). Check with
get_status or by inspecting the score.
For a passage, put rest events in a ScoreSpec and use write_score. Use
goto_bar first to choose where a single rest lands.
Do not read can_undo as evidence: entering note input alone already sets it.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "add_rest"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| duration | No | Rhythmic duration, one of: whole, half, quarter, eighth, sixteenth, 32nd, 64th. Case-insensitive. | quarter |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||