Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_insert_soft_goods

Places a Spotlight Soft Goods run (curtain, truss border, or pipe-and-drape) along a polyline, adding optional opening, track, pipe, traveler, and hardware.

Instructions

Place a Spotlight Soft Goods run (curtain, truss border or pipe-and-drape) along a path of points. Creates one Soft Goods object on the open polyline through points, height tall, with the optional opening and hardware. One revertible step removes it with its path. The geometry is read back after creation. Returns {uuid, center: [x, y, z], size: [w, d, h], path_length, class?}.

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": {
      "points": "<points>",
      "height": "<height>"
    },
    "name": "vw_insert_soft_goods"
  }
}

Input Schema

NameRequiredDescriptionDefault
layerNoDesign layer to place the new object(s) on, by name. Omitted: the user's active layer.
heightYesHeight of the curtain or border in document units.
pointsYesPath of the run as [[x, y], [x, y], ...] in document units; at least two points, an open polyline.
purposeNoText for the object's Spotlight 'Purpose' field. Omitted: left empty.
add_pipeNoTrue draws the hanging pipe.
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.
functionNoWhat the run is: 'Curtain', 'Truss Border' or 'Pipe-and-Drape'.Curtain
positionNoText for the object's Spotlight 'Position' field. Omitted: left empty.
travelerNoTrue marks the curtain as a traveler.
add_trackNoTrue draws the curtain track.
open_fromNoCurtains only: where the opening is, as the plug-in's popup text, for example 'Center'. Omitted: the plug-in default.
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.
opening_widthNoCurtains only: width of the opening in document units. Omitted: no opening.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field 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."
  2. Changed13 schema fields changedv0.1.1
    • addedInput schema / properties / add_pipe / description
      Added value: +"True draws the hanging pipe."
    • addedInput schema / properties / add_track / description
      Added value: +"True draws the curtain track."
    • 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 / function / description
      Added value: +"What the run is: 'Curtain', 'Truss Border' or 'Pipe-and-Drape'."
    • addedInput schema / properties / height / description
      Added value: +"Height of the curtain or border in document units."
    • 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 / open_from / description
      Added value: +"Curtains only: where the opening is, as the plug-in's popup text, for example 'Center'. Omitted: the plug-in default."
    • addedInput schema / properties / opening_width / description
      Added value: +"Curtains only: width of the opening in document units. Omitted: no opening."
    • addedInput schema / properties / points / description
      Added value: +"Path of the run as [[x, y], [x, y], ...] in document units; at least two points, an open polyline."
    • addedInput schema / properties / position / description
      Added value: +"Text for the object's Spotlight 'Position' field. Omitted: left empty."
    • addedInput schema / properties / purpose / description
      Added value: +"Text for the object's Spotlight 'Purpose' field. Omitted: left empty."
    • addedInput schema / properties / traveler / description
      Added value: +"True marks the curtain as a traveler."
  3. Added

TDQS

A4/5.0
Behavior4/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false, openWorldHint=false), it discloses that the insert is one revertible step coupled to its path and that geometry is read back after creation. It does not mention failure modes such as a nonexistent class or wrong front document, but the undo and verification behavior is genuinely useful added context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four sentences, front-loaded with what is created, then scope details, then undo/verification semantics, then the return tuple. No filler or repetition of the schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With 13 parameters, no output schema, and only annotations for safety, the description covers the return shape and lifecycle behavior well. Minor gaps remain around permission/class-existence prerequisites and default layer behavior, but nothing that would block a correct call.

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 coverage is 100%, so the schema already explains all 13 parameters including the enum for function and the curtain-only constraints. The description only gestures at the optional opening and hardware plus height, adding little beyond what is structured; 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?

Names a concrete verb+resource and enumerates the three Soft Goods variants (curtain, truss border, pipe-and-drape) it produces along a point path. That specificity separates it cleanly from the other vw_insert_* siblings, which create bands, hoists, decks, or lighting devices.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The context of use is implied by the description (placing a soft-goods run along a polyline), but there is no explicit when-to-use/when-not guidance and no named alternative to route to. The only routing hint, the document/front-document prerequisite, lives in the schema rather than the description.

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