Skip to main content
Glama

connect_to_dorico

Establish a WebSocket connection to a running Dorico instance to enable command-based control through its Remote Control API.

Instructions

Connect to a running Dorico via its Remote Control API (experimental).

Dorico support is experimental: the Remote Control API is undocumented, command-only (it cannot read note content), and this bridge has not been verified against a running Dorico. Dorico 4 and later serve the API without a plugin; the port is set in Dorico's preferences. Connecting disconnects any other application.

Args: host: WebSocket host (default: localhost). port: WebSocket port (default: 4560, Dorico's default).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hostNolocalhost
portNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedOutput schema / $defs
      Added value: +{
      +  "CommandResult": {
      +    "additionalProperties": true,
      +    "type": "object"
      +  }
      +}
    • addedOutput schema / properties / result / $ref
      Added value: +"#/$defs/CommandResult"
    • removedOutput schema / properties / result / title
      Removed value: -"Result"
    • removedOutput schema / properties / result / type
      Removed value: -"string"
  2. First observedv0.1.0

TDQS

A4.7/5.0
Behavior5/5

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

With no annotations, the description fully carries the burden and does so well. It discloses that the API is undocumented, command-only, unverified against a running Dorico, and that connecting disconnects any other application—material side-effect information an agent needs.

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 description is front-loaded and mostly efficient, with only a minor redundancy: 'experimental' appears both in the first line and again in the second sentence. Every other sentence adds necessary caveats or parameter context.

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 two-parameter connection tool, this is complete: prerequisites, defaults, side effects, and limitations are all covered, and an output schema exists so return-value documentation is not required.

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

Parameters5/5

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

Schema coverage is 0%, but the description compensates by defining both parameters: 'WebSocket host' and 'WebSocket port (default: 4560, Dorico's default).' This adds protocol and default-context meaning beyond the raw schema fields.

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 opens with a specific verb and resource: 'Connect to a running Dorico via its Remote Control API.' This unambiguously identifies the tool's function and, by naming Dorico, distinguishes it from the Musescore sibling without requiring schema inspection.

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?

It gives clear context for use: a running Dorico 4+ with the Remote Control API enabled and the port set in preferences. It does not explicitly name alternatives or when not to use it, but the experimental caveats and prerequisites are enough to guide an agent.

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