Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_create_pio

Creates a Vectorworks or Spotlight plug-in object by internal name at a point and sets exact parameters; use it when no typed insert tool fits, with unknown parameter names aborting placement.

Instructions

Place one Vectorworks or Spotlight plug-in object by its internal name and set its parameters. The general-purpose way to create a plug-in object when no typed tool fits; prefer vw_insert_truss_run, vw_insert_lighting_devices, vw_insert_stage_decks and the other insert tools where they exist, since those know the objects' quirks. The object is created and regenerated with the given parameters; nothing else in the document is touched. Unknown parameter names abort the call and nothing is placed. One revertible step. Returns the new object's summary as vw_find_objects lists objects ({uuid, type, name, layer, class, bbox...}) plus class; read the resulting fields with vw_get_record.

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": {
      "plugin": "<plugin>",
      "x": "<x>",
      "y": "<y>"
    },
    "name": "vw_create_pio"
  }
}

Input Schema

NameRequiredDescriptionDefault
xYesInsertion point x in document units.
yYesInsertion point y in document units.
layerNoDesign layer to place the new object(s) on, by name. Omitted: the user's active layer.
pluginYesInternal plug-in name, case-sensitive: 'TrussItem', 'Lighting Device', 'Light Position Obj', ... Learn names from vw_find_objects(type='Plug-in Object') plus vw_get_record on an existing object.
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.
rotationNoRotation in degrees, counter-clockwise, 0 = along +x.
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.
parametersNoParameter fields to set by exact field name, for example {'Symbol': 'F34 Straight 2m', 'Name': 'T1'} for a TrussItem. An unknown name aborts the call. Omitted: plug-in defaults.

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 / plugin / description
      Previous value: -"Internal plug-in name, case-sensitive: 'TrussItem', 'Lighting Device', 'Light Position Obj', ... Learn names from vw_find_objects(type='Plug-in Object') plus vw_get_pio_parameters on an existing object."New value: +"Internal plug-in name, case-sensitive: 'TrussItem', 'Lighting Device', 'Light Position Obj', ... Learn names from vw_find_objects(type='Plug-in Object') plus vw_get_record on an existing object."
  2. Changed8 schema fields changedv0.1.1
    • 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 / 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 / parameters / description
      Added value: +"Parameter fields to set by exact field name, for example {'Symbol': 'F34 Straight 2m', 'Name': 'T1'} for a TrussItem. An unknown name aborts the call. Omitted: plug-in defaults."
    • addedInput schema / properties / plugin / description
      Added value: +"Internal plug-in name, case-sensitive: 'TrussItem', 'Lighting Device', 'Light Position Obj', ... Learn names from vw_find_objects(type='Plug-in Object') plus vw_get_pio_parameters on an existing object."
    • addedInput schema / properties / rotation / description
      Added value: +"Rotation in degrees, counter-clockwise, 0 = along +x."
    • addedInput schema / properties / x / description
      Added value: +"Insertion point x in document units."
    • addedInput schema / properties / y / description
      Added value: +"Insertion point y in document units."
  3. Added

TDQS

A4.8/5.0
Behavior5/5

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

Goes well beyond the annotations: it discloses that the object is regenerated with the given parameters, that nothing else in the document is touched, that unknown parameter names abort the entire call with nothing placed, and that the change is a single revertible step. It also describes the return payload shape, which matters since there is no output schema.

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-loads the core action, then alternatives, then transactional guarantees and return shape — a sensible order with no filler. It is dense and runs long for a tool description, but essentially every sentence carries disambiguating or safety information.

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 write tool with no output schema, it covers safety profile, atomicity, revert behavior, return shape and the natural sibling alternatives. Nothing an agent needs to invoke it correctly is missing.

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, and the description adds cross-field semantics the schema does not: the all-or-nothing behavior of the parameters map and a concrete example of field naming. It does not add much on x/y/layer/rotation, but those are already fully documented.

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?

Opens with a specific verb and resource ('Place one Vectorworks or Spotlight plug-in object by its internal name') and scopes it as the generic fallback versus the typed insert tools. An agent can distinguish it from vw_insert_truss_run / vw_insert_lighting_devices without opening any 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?

Explicitly states when to prefer alternatives ('prefer vw_insert_truss_run, vw_insert_lighting_devices, vw_insert_stage_decks and the other insert tools where they exist, since those know the objects' quirks') and why. It also routes the follow-up read to vw_get_record, so the whole select-then-verify flow is spelled out.

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