Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_mvr_check

Read-only

Check lighting device data for gaps that would make an MVR export incomplete, including missing GDTF types, Fixture IDs, DMX patches, and overlapping footprints before export.

Instructions

Check the Lighting Device data for the gaps that make an MVR export incomplete, before the user runs File > Export > Export MVR.

Read-only; nothing changes and the export itself is a menu action the user runs (there is no scripting call for it). Errors, which would break or empty the MVR (My Virtual Rig) file: no GDTF fixture type, no fixture mode, missing or duplicate Fixture ID, no DMX patch, overlapping DMX footprints in one universe, footprint past channel 512. Warnings: device without position, position name with no position object, symbol with 2D geometry only (exports as empty geometry), symbol missing from the document. Returns {ok, device_count, summary: {check: count}, issues: [{check, severity: "error" | "warning", message, devices: [{uuid, position, unit, channel}]}], document, next_steps}; a "field_missing" issue lists the fields this document lacks, whose checks were skipped. Fix findings with vw_set_lighting_device_fields (Fixture ID, UniverseAddress, Position, Fixture Mode), the Object Info palette (GDTF fixture) or by importing a hybrid symbol (vw_list_library, vw_import_resource), then check again.

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

Input Schema

NameRequiredDescriptionDefault
positionNoLimit the check to the devices on this position (exact name). Omit for the whole plot.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.1
    • addedInput schema / properties / position / description
      Added value: +"Limit the check to the devices on this position (exact name). Omit for the whole plot."
  2. Added

TDQS

A4.6/5.0
Behavior5/5

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

The read-only, non-open-world behavior is consistent with readOnlyHint and openWorldHint annotations, and the description adds substantial context beyond them: the split between errors that break or empty the MVR and warnings that merely degrade output, plus the field_missing case where checks are skipped. The return envelope (ok, device_count, summary, issues with severity, document, next_steps) is spelled out.

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?

Front-loaded with purpose and timing, then errors, warnings, return shape, and fixes in a logical order. The dense run-on enumeration of error conditions and the inline return-shape block are information-rich but slightly hard to scan; a bulleted structure would read faster.

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?

Although there is no output schema, the description fully specifies the return object and the severity semantics, and it explains the remediation loop (fix, then check again). For a one-parameter diagnostic tool this leaves nothing an agent needs unanswered.

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?

The single optional position parameter is fully documented in the schema (100% coverage), including that it is an exact-name match and that omitting it covers the whole plot. The description itself never mentions the position filter, so it adds nothing beyond the schema here; baseline 3 applies.

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 names a specific verb and resource — checking Lighting Device data for gaps that make an MVR export incomplete — and anchors it to a concrete user moment (File > Export > Export MVR). It is clearly distinguishable from siblings like vw_lighting_device_report or vw_set_lighting_device_fields.

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?

Explicit about when to use it (a pre-export check, before the user runs Export MVR) and about what it is not (read-only; the export itself is a menu action with no scripting call). It also routes the agent to the correct remediation tools: vw_set_lighting_device_fields, vw_list_library, vw_import_resource, or the Object Info palette.

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