Skip to main content
Glama
Dorico Maestro

Dorico Maestro

playback_state

Read-onlyIdempotent

Reports whether a project can play and which expression maps are in use, helping you confirm playback activation and inspect maps used by selected instruments.

Instructions

Report whether the project can play, and which expression maps are in use.

Returns:
    Result dictionary with ``activated_for_playback``, ``in_playback``, the
    edition, the expression maps in the project's library (id and name), and
    the maps used by the selected instruments when something is selected.

Note:
    A project that is not activated for playback plays nothing, and Dorico's
    routing menus do nothing until it is: call activate_playback first.

    The Remote API has no query for VST slots, loaded plugins or channel
    routing, so they are not here. ``selection_expression_maps`` comes from
    ``getplaybacktechniques`` and is empty without a selection; select an
    instrument's music first to read its map (Dorico Elements 6.2.40).

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

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.8

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), and the description goes well beyond them: it discloses that VST slots, loaded plugins and channel routing are unavailable, that selection_expression_maps is empty without a selection, and that the map read depends on a specific Dorico version. These are exactly the limits an agent needs before trusting the output.

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

Conciseness3/5

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

The purpose is front-loaded and the Note section carries the real value, but the multi-line "Returns:" block restates field names that an output schema already documents, padding length without adding meaning. Prose is clear but the structure would be tighter without the redundant return enumeration.

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 zero-parameter read tool with an output schema and full annotations, the description covers the key preconditions (activation, selection) and the scope limits. It stops short of explaining what specific keys like activated_for_playback versus in_playback mean semantically, but nothing critical to calling 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?

The tool takes zero parameters, so there is nothing for the description to disambiguate; baseline 4 applies. No misleading claims about inputs are present.

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 states a specific verb ("Report") and a specific resource/scope ("whether the project can play, and which expression maps are in use"). It is clearly distinguishable from the mutation sibling activate_playback, which the description explicitly names as a prerequisite.

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?

Guidance is concrete: call activate_playback first because nothing plays otherwise, and select an instrument's music first if you want selection_expression_maps populated. It also implicitly routes away from plugin_state-type queries by stating the Remote API has no VST/plugin/routing query, though it never names an alternative tool for those needs explicitly.

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