Dorico Maestro

Overview Schema Source Related Servers Discussions Admin

switch_mode

Idempotent

Switch Dorico's workspace mode to setup, write, engrave, play, or print without altering notes or playback. Use write mode before composing notes, rests, or moving the caret.

Instructions

Switch which of Dorico's five workspace modes is on screen.

Changes the window and nothing in the music: no notes, no playback position and
no selection move as a result.

Returns:
    Result dictionary reporting whether the switch was accepted.

Note:
    Note entry needs write mode, so switch there before add_notes, add_rest,
    goto_bar or write_score if the project might be in another one. get_status
    reports which mode is active without changing it.

    This is not navigation. To scroll the score use navigate, and to move the
    caret use goto_bar.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`mode`	Yes	Which mode to show: 'setup' for players, layouts and flows, 'write' for note entry and editing, 'engrave' for graphical adjustment and spacing, 'play' for the track view and VST instruments, 'print' for print and export setup. The raw kName forms are accepted too.

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.1.2Sep 7, 2026

addedInput schema / properties / mode / description

Added value: +"Which mode to show: 'setup' for players, layouts and flows, 'write' for note entry and editing, 'engrave' for graphical adjustment and spacing, 'play' for the track view and VST instruments, 'print' for print and export setup. The raw kName forms are accepted too."

First observedv0.1.0Aug 11, 2026

TDQS

A4.9/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

While the idempotentHint annotation is present, the description adds concrete behavioral detail: it changes only the window, doesn't affect notes, playback position, or selection, and reports whether the switch was accepted. It also clarifies that the mode change is not read-only in the annotation sense but is still non-destructive.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-organized with a clear first sentence, explicit side-effect statement, return mention, and practical note. Every section adds distinct value and important information is front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool is conceptually simple with one parameter, an output schema, and annotations. The description fully covers purpose, side effects, prerequisites, and exclusions relative to sibling tools. Nothing an agent needs to call it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with a detailed mode parameter description listing all five values and their meanings. The description adds value by tying those modes to practical workflow context (e.g., write mode is needed before note-entry tools), which helps the agent pick the right mode value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('Switch') and resource ('Dorico's five workspace modes') and immediately distinguishes the tool from navigation tools by explicitly saying this is not navigation. An agent can understand exactly what mode switching accomplishes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives explicit when-to-use guidance: switch to write mode before note-entry tools if needed, and explicitly contrasts with navigate and goto_bar for scrolling and caret movement. This is ideal routing guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.