Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_insert_truss_run

Places a straight run of truss pieces end to end or stacks them into a vertical tower, creating one linked truss system for rigging layouts.

Instructions

Place a straight run of truss pieces end to end, or stack them into a tower, linked into one truss system the way Spotlight's Insert Truss tool does. Creates count TrussItem objects on the symbol's length centres from (x, y) along rotation, dimensions, weight and type from the symbol's Braceworks record, chained into a new truss system. With vertical=True the pieces are stacked upward from (x, y, z) into a tower, optionally on a base plate and under a top piece. Shapes with corners are vw_insert_truss_path; for a single odd piece use vw_create_pio with 'TrussItem'. All-or-nothing; one revertible step removes the whole run (and the import, if any). Returns {system, piece_length, total_length, vertical, imported, pieces: [{uuid, bbox}] (towers: [{uuid, symbol, z}] plus total_height), class?}; check with vw_list_truss.

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>",
      "count": "<count>"
    },
    "name": "vw_insert_truss_run"
  }
}

Input Schema

NameRequiredDescriptionDefault
xYesStart point x of the run in document units (the first piece begins here).
yYesStart point y of the run in document units.
zNoHow high to raise the truss in document units: its underside sits at z, the centre line half the truss height above (live 2026-11-21).
countYesNumber of pieces placed end to end; at least 1.
layerNoDesign layer to place the new object(s) on, by name. Omitted: the user's active layer.
symbolYesName of a truss symbol already in the document (vw_list_symbols), or in the library file given as library_path.
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.
rotationNoDirection of the run in degrees: 0 = along +x, 90 = along +y.
verticalNoTrue: a tower. The pieces stand on end, stacked upward from (x, y) at height z; rotation is ignored. Default False: a horizontal run.
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.
top_symbolNoWith vertical: a top piece (spindle, sleeve) of the same family placed on top of the stack, such as 'Global Truss F34 Spindel'.
base_symbolNoWith vertical: a base plate symbol of the same family placed under the stack, such as 'Global Truss F34 800mm Steel Plate Base' (import it first).
library_pathNoLibrary .vwx path (vw_list_library) to import the symbol from first, when it is not in the document yet.
position_nameNoSpotlight position name written into every piece, so lighting devices can refer to the run. Omitted: left empty.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.2.0
    • addedInput schema / properties / base_symbol
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "With vertical: a base plate symbol of the same family placed under the stack, such as 'Global Truss F34 800mm Steel Plate Base' (import it first).",
      +  "title": "Base Symbol"
      +}
    • 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."
    • addedInput schema / properties / top_symbol
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "With vertical: a top piece (spindle, sleeve) of the same family placed on top of the stack, such as 'Global Truss F34 Spindel'.",
      +  "title": "Top Symbol"
      +}
    • addedInput schema / properties / vertical
      Added value: +{
      +  "default": false,
      +  "description": "True: a tower. The pieces stand on end, stacked upward from (x, y) at height z; rotation is ignored. Default False: a horizontal run.",
      +  "title": "Vertical",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / z / description
      Previous value: -"Height of the truss centre line in document units."New value: +"How high to raise the truss in document units: its underside sits at z, the centre line half the truss height above (live 2026-11-21)."
  2. Changed11 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 / count / description
      Added value: +"Number of pieces placed end to end; 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_name / description
      Added value: +"Spotlight position name written into every piece, so lighting devices can refer to the run. Omitted: left empty."
    • addedInput schema / properties / rotation / description
      Added value: +"Direction of the run in degrees: 0 = along +x, 90 = along +y."
    • addedInput schema / properties / symbol / description
      Added value: +"Name of a truss symbol already in the document (vw_list_symbols), or in the library file given as library_path."
    • addedInput schema / properties / x / description
      Added value: +"Start point x of the run in document units (the first piece begins here)."
    • addedInput schema / properties / y / description
      Added value: +"Start point y of the run in document units."
    • addedInput schema / properties / z / description
      Added value: +"Height of the truss centre line 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 by disclosing transactional behavior ('All-or-nothing; one revertible step removes the whole run (and the import, if any)'), a side effect not obvious from the schema (class applied in a second job after the insert), and the full return payload. This is exactly the mutation context that readOnly/destructive hints cannot convey.

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 two alternatives are front-loaded in the first and third sentences, which is the right ordering. The return-shape sentence is a dense parenthetical block with nested braces and an odd 'class?'/'imported' shorthand that takes effort to parse, though nothing is genuinely 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 14-parameter mutation with no output schema, the description supplies the missing return contract (system, piece_length, total_length, pieces with uuids/bboxes, tower z values and total_height) plus the atomicity and document-precondition behavior. An agent has everything needed to invoke 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 already 100%, so the baseline is 3; the description still adds relational meaning the schema states only piecemeal: pieces are created on the symbol's length centres, each piece inherits dimensions/weight/type from the Braceworks record, and rotation is ignored when vertical. Some of this duplicates per-parameter text, which caps it below 5.

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?

States a concrete verb and resource ('Place a straight run of truss pieces end to end, or stack them into a tower ... chained into a new truss system') and ties it to a known reference, Spotlight's Insert Truss. It explicitly distinguishes itself from vw_insert_truss_path (shapes with corners) and vw_create_pio with 'TrussItem' (single odd piece), so an agent can select it 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?

Names both alternatives and the exact conditions that select them ('Shapes with corners are vw_insert_truss_path; for a single odd piece use vw_create_pio with TrussItem'), and points to vw_list_truss for verification. It also states a usage precondition for writes: always pass `document`, and switch documents first if another is in front.

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