Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_insert_platform

Build a stage-deck platform with one flight of steps on a chosen edge as one revertible action; returns deck and step geometry.

Instructions

Build a platform of Stage Decks together with one flight of Stage Steps on a chosen edge, as one revertible step. The decks are laid out exactly as vw_insert_stage_decks does; the flight is centred on the steps_on edge and descends away from the platform. Use vw_insert_stage_decks or vw_insert_stage_steps alone when only one part is wanted. All document units. One vw_revert_last removes decks and steps together. Returns {decks: [{uuid, center, size}], footprint, steps: {uuid, steps, center, size}?, class?} with geometry read back after creation.

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": {
      "width": "<width>",
      "depth": "<depth>",
      "height": "<height>",
      "x": "<x>",
      "y": "<y>"
    },
    "name": "vw_insert_platform"
  }
}

Input Schema

NameRequiredDescriptionDefault
xYesPlatform corner x in document units: each deck extends +width along `rotation` and +depth at 90 degrees from it, so at rotation 0 the platform fills x..x+width*columns, y..y+depth*rows.
yYesPlatform corner y in document units: each deck extends +width along `rotation` and +depth at 90 degrees from it, so at rotation 0 the platform fills x..x+width*columns, y..y+depth*rows.
rowsNoNumber of decks across; at least 1.
depthYesDepth of one deck in document units, across `rotation`.
layerNoDesign layer to place the new object(s) on, by name. Omitted: the user's active layer.
railsNoTrue adds a handrail on both sides of the steps.
widthYesWidth of one deck in document units, measured along `rotation`.
heightYesDeck top height above the floor in document units; also the stage height the steps descend.
columnsNoNumber of decks along `rotation`; at least 1.
purposeNoText for the object's Spotlight 'Purpose' field. Omitted: left empty. Applied to decks and steps.
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.
positionNoText for the object's Spotlight 'Position' field. Omitted: left empty. Applied to decks and steps.
rotationNoPlatform direction in degrees: 0 = width along +x, 90 = along +y.
steps_onNoEdge that gets the flight of steps, in the platform's own frame: 'front' is the edge through (x, y) along `rotation`, 'back' the opposite edge, 'left' the edge through (x, y) across, 'right' the opposite. Omitted: decks only.
step_kindNoStage Steps type: 'Self-Adjusting' (rental unit with a fixed stringer, shallow pitch on low stages), 'Frame Free-Standing', 'Solid Free-Standing', 'Open Free-Standing' or 'Simple' (compact flight).Self-Adjusting
structureNoLeg style of each deck: 'Legs-Basic', 'Legs-Braced', 'Folding', 'Deck Only', 'Border' or 'Simple'.Legs-Basic
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.
step_countNoNumber of steps in the flight. Omitted: about one per 8 inches of height.
tread_widthNoWidth of the flight in document units. Omitted: the plug-in default.

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. Changed19 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 / columns / description
      Added value: +"Number of decks along `rotation`; at least 1."
    • addedInput schema / properties / depth / description
      Added value: +"Depth of one deck in document units, across `rotation`."
    • 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 / height / description
      Added value: +"Deck top height above the floor in document units; also the stage height the steps descend."
    • 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 / position / description
      Added value: +"Text for the object's Spotlight 'Position' field. Omitted: left empty. Applied to decks and steps."
    • addedInput schema / properties / purpose / description
      Added value: +"Text for the object's Spotlight 'Purpose' field. Omitted: left empty. Applied to decks and steps."
    • addedInput schema / properties / rails / description
      Added value: +"True adds a handrail on both sides of the steps."
    • addedInput schema / properties / rotation / description
      Added value: +"Platform direction in degrees: 0 = width along +x, 90 = along +y."
    • addedInput schema / properties / rows / description
      Added value: +"Number of decks across; at least 1."
    • addedInput schema / properties / step_count / description
      Added value: +"Number of steps in the flight. Omitted: about one per 8 inches of height."
    • addedInput schema / properties / step_kind / description
      Added value: +"Stage Steps type: 'Self-Adjusting' (rental unit with a fixed stringer, shallow pitch on low stages), 'Frame Free-Standing', 'Solid Free-Standing', 'Open Free-Standing' or 'Simple' (compact flight)."
    • addedInput schema / properties / steps_on / description
      Added value: +"Edge that gets the flight of steps, in the platform's own frame: 'front' is the edge through (x, y) along `rotation`, 'back' the opposite edge, 'left' the edge through (x, y) across, 'right' the opposite. Omitted: decks only."
    • addedInput schema / properties / structure / description
      Added value: +"Leg style of each deck: 'Legs-Basic', 'Legs-Braced', 'Folding', 'Deck Only', 'Border' or 'Simple'."
    • addedInput schema / properties / tread_width / description
      Added value: +"Width of the flight in document units. Omitted: the plug-in default."
    • addedInput schema / properties / width / description
      Added value: +"Width of one deck in document units, measured along `rotation`."
    • addedInput schema / properties / x / description
      Added value: +"Platform corner x in document units: each deck extends +width along `rotation` and +depth at 90 degrees from it, so at rotation 0 the platform fills x..x+width*columns, y..y+depth*rows."
    • addedInput schema / properties / y / description
      Added value: +"Platform corner y in document units: each deck extends +width along `rotation` and +depth at 90 degrees from it, so at rotation 0 the platform fills x..x+width*columns, y..y+depth*rows."
  3. Added

TDQS

A4.5/5.0
Behavior4/5

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

Beyond the annotations (which only cover write/non-destructive/closed-world), the description discloses atomicity ('one revertible step'), undo semantics ('One vw_revert_last removes decks and steps together'), and that geometry is read back after creation. It does not restate safety hints and adds genuine operational context; the only gap is no discussion of failure modes (e.g., class or document preconditions, which are covered in the schema instead).

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?

Front-loaded with what it builds, followed by layout semantics, alternative routing, units, undo behaviour, and return shape in that order. Six sentences, each carrying distinct information with no repetition of the schema.

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 19-parameter composite creation tool with no output schema, the description supplies the missing return shape ({decks, footprint, steps...}) and the undo/atomicity model. Combined with 100% schema coverage, an agent has enough to invoke it correctly.

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 the schema already documents all 19 parameters, including steps_on, class_name, and document. The description adds only modest meaning beyond that — the global 'All document units' note and the fact that the flight is centred on steps_on and descends away — so the 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?

States a specific composite action: build a platform of Stage Decks plus one flight of Stage Steps on a chosen edge, as a single revertible step. It also distinguishes itself from vw_insert_stage_decks and vw_insert_stage_steps, so an agent can route correctly 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?

Explicitly says to use vw_insert_stage_decks or vw_insert_stage_steps alone when only one part is wanted, and the steps_on parameter ('Omitted: decks only') gives the in-call condition for skipping the flight. Both the when and the alternative are stated rather than inferred.

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