Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_insert_band

Places band members or backline symbols on stage at set coordinates, each with an optional name label. Inserts multiple symbols in one revertible step.

Instructions

Place a band or crew on stage: people or backline symbols at given points, each with a name label. The symbols must already be in the document (vw_list_symbols); bring them in first with vw_list_library and vw_import_resource. For a single symbol without a label use vw_insert_symbol. All-or-nothing; one revertible step removes symbols and labels together. Returns {members: [{uuid, label_uuid, ...}], 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": {
      "members": "<members>"
    },
    "name": "vw_insert_band"
  }
}

Input Schema

NameRequiredDescriptionDefault
labelNoTrue adds a centred text label with each member's name below the symbol.
layerNoDesign layer to place the new object(s) on, by name. Omitted: the user's active layer.
membersYesOne entry per person or instrument: {'symbol': name of a symbol in the document, 'x': ..., 'y': ... (document units), optional 'z', 'rotation' in degrees (default 0) and 'name' for the label (default: the symbol name)}. At least one.
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.
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. Applied to symbols and labels.
label_offset_mmNoDistance in millimetres from the symbol's insertion point down to the label.

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. Applied to symbols and labels."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. Applied to symbols and labels."
  2. Changed6 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. Applied to symbols and labels."
    • 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 / label / description
      Added value: +"True adds a centred text label with each member's name below the symbol."
    • addedInput schema / properties / label_offset_mm / description
      Added value: +"Distance in millimetres from the symbol's insertion point down to the label."
    • 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 / members / description
      Added value: +"One entry per person or instrument: {'symbol': name of a symbol in the document, 'x': ..., 'y': ... (document units), optional 'z', 'rotation' in degrees (default 0) and 'name' for the label (default: the symbol name)}. At least one."
  3. Added

TDQS

A4.7/5.0
Behavior5/5

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

Annotations only declare write/non-destructive/non-open-world; the description adds real behavior: the operation is all-or-nothing, one revertible step removes symbols and labels together, and the class assignment runs as a second job after the insert. It also discloses the return shape even though no output schema exists.

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?

The purpose is front-loaded in the first clause, followed by prerequisites, the alternative tool, transactional semantics, and the return shape, with no filler sentences. Line-wrapped but every clause carries distinct information an agent needs.

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 6-parameter write tool with no output schema, the description covers the transaction model, prerequisites, alternative, and return value, leaving nothing essential ambiguous. The remaining parameter detail is fully carried by a 100%-covered schema.

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% and the schema already spells out members, label, layer, document, class_name and label_offset_mm in detail. The description adds only the high-level 'each with a name label' framing, so the baseline of 3 applies rather than a bonus for compensating meaning.

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 band or crew on stage: people or backline symbols at given points, each with a name label') and explicitly distinguishes itself from the sibling vw_insert_symbol for the single-unlabelled-symbol case.

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?

Gives prerequisites (symbols must already exist in the document, discovered via vw_list_symbols, brought in via vw_list_library and vw_import_resource) and names the alternative tool with the condition that selects it. The 'Always pass it for writes' note on the document param further steers correct invocation.

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