Skip to main content
Glama
Dorico Maestro

Dorico Maestro

read_playback_setup

Read-onlyIdempotent

Read a saved .dorico project's VST slots, routing, and expression maps to check playback setup and report mismatches between Dorico and the audio engine.

Instructions

Read a saved project's VST slots, routing and expression maps, and check them.

Returns:
    Result dictionary with ``slots`` (Dorico's rack beside what the audio engine
    hosts), ``instruments`` (player, ``instrument_id`` and routes) and ``problems``.

Note:
    Offline and read-only; for the open project, save first. ``instrument_id`` is
    the id playback_setup(action='route') needs. A problem such as "Dorico lists
    a sampler, the audio engine hosts HALion Sonic" means the slot will not sound as
    shown, which pushed status cannot reveal (Dorico Elements 6.2.40).

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": "read_playback_setup"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesA saved .dorico project, autosaves included.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.8

TDQS

A4.3/5.0
Behavior5/5

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

Annotations already declare read-only, idempotent, non-destructive, closed-world behavior, so the description only needs to add context — and it does: offline operation, the save-first requirement, and, importantly, what a ``problems`` entry actually means (a slot that will not sound as shown). The remark that this condition cannot be revealed by pushed status is substantive behavioral knowledge an agent could not derive from annotations or schema.

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

Conciseness4/5

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

The purpose is front-loaded and the Returns/Note blocks keep secondary facts out of the way. A few passages are dense and idiosyncratic (the parenthetical version cite, the quoted problem string), which costs a little readability but not correctness.

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

Completeness4/5

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

For a one-parameter offline read tool this is nearly complete: it covers the prerequisite, the failure mode, and how the returned ``instrument_id`` feeds the routing tool. Since an output schema exists, the Returns block is partly redundant, and the description does not explicitly say which sibling to use for mutation instead.

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

Parameters3/5

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

There is a single parameter with 100% schema description coverage ('A saved .dorico project, autosaves included'), so the schema carries the semantics and a 3 baseline applies. The description's 'for the open project, save first' does add a little meaning about the path requirement, but adds no format or syntactic detail beyond the schema.

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 opening sentence gives a specific verb (Read) plus the resources it covers (VST slots, routing, expression maps) and scopes them to a saved project, with 'check them' elaborated by the Returns block. It also names the sibling relationship by stating that ``instrument_id`` is what playback_setup(action='route') needs, so an agent can place this tool relative to the routing tool.

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

Usage Guidelines4/5

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

The Note supplies real context: it is offline, it operates on a saved file, and for the open project you must save first — that prerequisite is genuinely actionable. It stops short of an explicit 'use X instead when Y' exclusion (e.g. use playback_setup to change routing rather than read it), leaving that inference to the reader.

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