Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_lightwright_snapshot

Read-only

Reads lighting devices from the saved Lightwright Data Exchange XML as of the last export, providing offline snapshot data with UIDs and fields even while other Vectorworks tools are blocked.

Instructions

Read the Lighting Devices as Spotlight's Lightwright Data Exchange file last exported them, from the XML beside the saved document.

Read-only. The file itself is read without a job (only the document's path is asked from Vectorworks), so this works even while a dialog blocks the other tools, but it shows the plot as of the last export, which can be older than the drawing; vw_list_lighting_devices is the live view. Returns {available, path, exported (timestamp), fields, count, fixtures: [{uid, lightwright_id, accessories, ...}]}; {available: False, hint} when the exchange is off (the hint says how to switch it on); and count 0 with a hint right after a vw_lightwright_patch, when Vectorworks has written back only an acknowledgement and the user must redo the full export. UIDs from here are what vw_lightwright_patch takes.

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_lightwright_snapshot"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of fixtures returned (`count` still gives the total). Default 2000.
fieldsNoExchange column names to keep, as the file spells them (Channel, Unit_Number, Inst_Type, Purpose, Color, Absolute_Address, User_Field_1 ...; the result's `fields` lists what the export contains). `uid` is always included. Omit for every column.
positionNoOnly fixtures whose Position matches this name (case-insensitive). Omit for all.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.1.1
    • addedInput schema / properties / fields / description
      Added value: +"Exchange column names to keep, as the file spells them (Channel, Unit_Number, Inst_Type, Purpose, Color, Absolute_Address, User_Field_1 ...; the result's `fields` lists what the export contains). `uid` is always included. Omit for every column."
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of fixtures returned (`count` still gives the total). Default 2000."
    • addedInput schema / properties / position / description
      Added value: +"Only fixtures whose Position matches this name (case-insensitive). Omit for all."
  2. Added

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the readOnlyHint/openWorldHint annotations, it discloses the no-job file read that makes it usable while blocked, the staleness risk, the exact return shape, the {available: False, hint} failure mode, and the UID hand-off to vw_lightwright_patch. This is substantive behavioral context an agent cannot get from structured fields.

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 most important facts (what it reads, read-only, staleness vs. the live sibling) are front-loaded, and the parenthetical detail is dense but purposeful. A few clause-heavy sentences could be split, but no sentence is 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?

There is no output schema, so the description carries the return-value burden itself, and it does so precisely — enumerating available, path, exported, fields, count, fixtures, plus the hint variants. Nothing an agent needs to call this correctly is missing.

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?

Schema description coverage is 100%, so limit, fields, and position are already fully documented there. The description adds little parameter-level meaning beyond noting that the result's `fields` lists what the export contains, which is already in the schema text — baseline 3 is appropriate.

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 states a specific verb and resource — reading Lighting Devices as the Lightwright Data Exchange file last exported, taken from the XML beside the saved document — and explicitly contrasts it with the live view in vw_list_lighting_devices. An agent can distinguish it from the sibling without opening the schema.

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?

It gives explicit when-to-use conditions (works even while a dialog blocks other tools) and when-not (the plot may be older than the drawing; use vw_list_lighting_devices for the live view). It also flags the post-vw_lightwright_patch edge case where count returns 0 and the user must redo the full export.

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