Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_insert_lighting_devices

Hangs a row of lighting fixtures as real Spotlight Lighting Devices at a set spacing and rotation, assigning position, unit numbers, channels and purpose in one revertible step.

Instructions

Hang a row of lighting fixtures as real Spotlight Lighting Devices with position, unit numbers, channels and purpose set. Places the symbol count times from (x, y) along rotation, spacing apart, and converts each to a Lighting Device the way Spotlight's insertion tool does, so Inst Type, wattage, DMX footprint and GDTF data come from the symbol. To change fixtures that already exist use vw_set_lighting_device_fields; to place a plain (non-fixture) symbol use vw_insert_symbol. All-or-nothing; one revertible step removes them all. Fields are re-read after Spotlight's reset: trust the returned values, and anything Spotlight overrode is listed under not_applied. Returns {devices: [{uuid, unit, inst_type, Position, Unit Number, Channel, Purpose, Inst Type}], imported, z, class?, not_applied?}.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "symbol": "<symbol>",
      "x": "<x>",
      "y": "<y>"
    },
    "name": "vw_insert_lighting_devices"
  }
}

Input Schema

NameRequiredDescriptionDefault
xYesFirst fixture's x in document units.
yYesFirst fixture's y in document units.
zNoExplicit hanging height in document units. Omitted: the position's height.
countNoHow many fixtures to hang in a row; at least 1.
layerNoDesign layer to place the new object(s) on, by name. Omitted: the user's active layer.
symbolYesName of a fixture symbol already in the document (vw_list_symbols), or in the library file given as library_path.
channelNoChannel of the first fixture; following ones add channel_step. Omitted: Channel left empty.
purposeNoText for the object's Spotlight 'Purpose' field. Omitted: left empty.
spacingNoDistance between fixtures in document units, measured along `rotation`. 0 with count > 1 stacks them on one point.
documentNoName of the document this call may change, as listed by vw_list_documents. If given and another document is in front, nothing changes and the call fails; use vw_switch_document first. Always pass it for writes.
positionNoSpotlight Position name to hang them on, as listed by vw_list_positions; the fixtures are raised to that position's height unless z is given. Omitted: no position, height z or 0.
rotationNoDirection of the row in degrees: 0 = along +x, 90 = along +y.
unit_stepNoIncrement of the Unit Number from one fixture to the next.
class_nameNoClass to assign to the new object(s), by name; it must exist (vw_create_class or vw_apply_class_standard first). Applied in a second job after the insert. Omitted: the user's active class.
start_unitNoUnit Number of the first fixture; following ones add unit_step. None leaves Unit Number empty.
channel_stepNoIncrement of the Channel from one fixture to the next.
library_pathNoLibrary .vwx path (vw_list_library) to import the symbol from first, when it is not in the document yet.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.2.0
    • changedInput schema / properties / class_name / description
      Previous value: -"Class to assign to the new object(s), by name (created if missing). Applied in a second step and reported as 'class' in the result. Omitted: the active class."New value: +"Class to assign to the new object(s), by name; it must exist (vw_create_class or vw_apply_class_standard first). Applied in a second job after the insert. Omitted: the user's active class."
    • changedInput schema / properties / library_path / description
      Previous value: -"Library .vwx path (vw_list_library_files) to import the symbol from first, when it is not in the document yet."New value: +"Library .vwx path (vw_list_library) to import the symbol from first, when it is not in the document yet."
  2. Changed17 schema fields changedv0.1.1
    • addedInput schema / properties / channel / description
      Added value: +"Channel of the first fixture; following ones add channel_step. Omitted: Channel left empty."
    • addedInput schema / properties / channel_step / description
      Added value: +"Increment of the Channel from one fixture to the next."
    • addedInput schema / properties / class_name / description
      Added value: +"Class to assign to the new object(s), by name (created if missing). Applied in a second step and reported as 'class' in the result. Omitted: the active class."
    • addedInput schema / properties / count / description
      Added value: +"How many fixtures to hang in a row; at least 1."
    • addedInput schema / properties / document / description
      Added value: +"Name of the document this call may change, as listed by vw_list_documents. If given and another document is in front, nothing changes and the call fails; use vw_switch_document first. Always pass it for writes."
    • addedInput schema / properties / layer / description
      Added value: +"Design layer to place the new object(s) on, by name. Omitted: the user's active layer."
    • addedInput schema / properties / library_path / description
      Added value: +"Library .vwx path (vw_list_library_files) to import the symbol from first, when it is not in the document yet."
    • addedInput schema / properties / position / description
      Added value: +"Spotlight Position name to hang them on, as listed by vw_list_positions; the fixtures are raised to that position's height unless z is given. Omitted: no position, height z or 0."
    • addedInput schema / properties / purpose / description
      Added value: +"Text for the object's Spotlight 'Purpose' field. Omitted: left empty."
    • addedInput schema / properties / rotation / description
      Added value: +"Direction of the row in degrees: 0 = along +x, 90 = along +y."
    • addedInput schema / properties / spacing / description
      Added value: +"Distance between fixtures in document units, measured along `rotation`. 0 with count > 1 stacks them on one point."
    • addedInput schema / properties / start_unit / description
      Added value: +"Unit Number of the first fixture; following ones add unit_step. None leaves Unit Number empty."
    • addedInput schema / properties / symbol / description
      Added value: +"Name of a fixture symbol already in the document (vw_list_symbols), or in the library file given as library_path."
    • addedInput schema / properties / unit_step / description
      Added value: +"Increment of the Unit Number from one fixture to the next."
    • addedInput schema / properties / x / description
      Added value: +"First fixture's x in document units."
    • addedInput schema / properties / y / description
      Added value: +"First fixture's y in document units."
    • addedInput schema / properties / z / description
      Added value: +"Explicit hanging height in document units. Omitted: the position's height."
  3. Added

TDQS

A4.6/5.0
Behavior4/5

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

Beyond the annotations it discloses the all-or-nothing transactional behavior, that one revertible step removes everything, that Spotlight's reset may override requested values, and that overrides are reported under not_applied. That is meaningful context for a non-destructive write with openWorldHint=false. It stops short of stating timing or scale limits for large counts.

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?

Purpose and the sibling routing are front-loaded, then geometry, then return shape — a sensible order with no filler sentences. It is dense and slightly run-on with stacked parentheticals, which costs a little readability but no information is wasted.

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 17-parameter mutation tool with no output schema, the description covers the row layout, the write-precondition, failure semantics, and the exact returned object shape including optional class and not_applied. An agent has everything needed to call it and interpret the result.

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%, so the baseline is 3, but the description adds real meaning: the row geometry (count placed from x,y along rotation, spacing apart), that class_name is applied in a second job after the insert, and that channel/unit steps propagate across the row. It does not restate per-parameter defaults, which the schema already carries.

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?

"Hang a row of lighting fixtures as real Spotlight Lighting Devices" is a specific verb plus resource, and it immediately states what distinguishes the result (converted to a Lighting Device the way Spotlight's insertion tool does, with Inst Type, wattage, DMX footprint and GDTF coming from the symbol). It also explicitly separates itself from vw_set_lighting_device_fields and vw_insert_symbol, so an agent can choose without opening either 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 names both alternatives and the exact condition that selects each: modify existing fixtures -> vw_set_lighting_device_fields, place a plain non-fixture symbol -> vw_insert_symbol. It also supplies a prerequisite rule for writes (pass document, otherwise the call fails if another document is in front).

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