Skip to main content
Glama
romanstark

Dorico Maestro

by romanstark
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

set_key_signature

Read-onlyIdempotent

Reports when a key signature cannot be set directly, then directs you to the key popover for interactive entry or to MusicXML/ScoreSpec for file-based setting.

Instructions

Report that a key signature cannot be set here, and what to use instead.

This writes nothing and always reports failure, for the same reason as
set_time_signature: Dorico takes a key signature only through an interactive
popover, and the Remote API cannot type into one.

Returns:
    Result dictionary explaining the limitation and naming the alternatives.

Note:
    For a person at the keyboard, open_popover(kind='key') opens the popover for
    them to type into. For an unattended write, put the key in a ScoreSpec and
    use write_score(method='musicxml') or export_musicxml, which set it through
    the file rather than the UI.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyNoThe key that was wanted, e.g. 'G major', 'C# minor' or 'Bb major'. Reported back in the answer so the caller can carry it to one of the alternatives. Nothing is written from it.C major

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.5
    • changedInput schema / properties / key / description
      Previous value: -"The key that was wanted, e.g. 'G major', 'C# minor' or 'Bb major'. Reported back in the answer so the caller can carry it to one of the alternatives; nothing is written from it."New value: +"The key that was wanted, e.g. 'G major', 'C# minor' or 'Bb major'. Reported back in the answer so the caller can carry it to one of the alternatives. Nothing is written from it."
  2. Changed1 schema field changedv0.1.2
    • addedInput schema / properties / key / description
      Added value: +"The key that was wanted, e.g. 'G major', 'C# minor' or 'Bb major'. Reported back in the answer so the caller can carry it to one of the alternatives; nothing is written from it."
  3. First observedv0.1.0

TDQS

A4.9/5.0
Behavior5/5

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

Discloses that it writes nothing and always reports failure, going beyond the readOnlyHint and idempotentHint annotations. It also explains why the limitation exists, which helps the agent understand that this is an intentional capability gap rather than an error.

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?

Every sentence earns its place: the primary behavior is front-loaded, the reason is explained, return semantics are stated, and the note cleanly separates the two practical alternatives. No redundant filler.

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?

For a deliberately failing tool with a single parameter, an output schema, and read-only annotations, the description is complete. It covers behavior, reason, return value, and the exact alternative tools to use, leaving no operational ambiguity.

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% and the parameter is well described there. The description adds useful context by explaining that the key value is simply reported back so the caller can carry it to an alternative, and that nothing is written from it.

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?

States a specific verb and resource: it reports that a key signature cannot be set and explains what to use instead. This clearly distinguishes it from a normal setter like set_time_signature or write_score by making its failure behavior explicit.

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?

Provides explicit guidance on when to use this tool versus alternatives: open_popover for a person at the keyboard, and write_score or export_musicxml for unattended writes. It also references set_time_signature to group related limitation-based tools.

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

Deploy Server

Other Tools