Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_create_class

Creates a single named class with default attributes in the open Vectorworks document, leaving the active class unchanged and moving no objects into it.

Instructions

Create one class in the open document with default attributes. For a whole consistent class set with colours and line weights use vw_apply_class_standard instead. The active class is left unchanged and no object is moved into the new class (pass class_name= to the insert tools, or vw_set_record). One revertible step: vw_revert_last deletes the class. Returns {name}.

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": {
      "name": "<name>"
    },
    "name": "vw_create_class"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesClass name; use '-' for hierarchy, for example 'Lighting-Truss'. Fails if the class exists.
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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.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 / name / description
      Added value: +"Class name; use '-' for hierarchy, for example 'Lighting-Truss'. Fails if the class exists."
  2. Added

TDQS

A4.7/5.0
Behavior5/5

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

Annotations only declare non-read-only, non-destructive, closed-world; the description adds the genuinely useful behavioral facts: it is a single revertible step, vw_revert_last deletes the class, the active class is left unchanged, and it returns {name}. That is exactly the mutation/reversibility context an agent needs and cannot get from the annotations.

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 short sentences, front-loaded with the primary action, then the alternative, then the side-effect constraints, then the return value. No filler; every clause carries a fact an agent would otherwise have to guess.

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 two-parameter creation tool with no output schema, the description supplies the return shape ({name}), reversibility, and the cross-tool workflow needed to actually use the new class. 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.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with 'name' documented (including the '-' hierarchy convention and the exists-failure) and 'document' fully explained. The description adds little parameter-level meaning beyond noting that class_name= is what downstream insert tools take; baseline 3 applies since the schema does the heavy lifting.

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 verb and resource with scope: 'Create one class in the open document with default attributes.' It immediately names the sibling it is not (vw_apply_class_standard) and the 'one class' vs 'whole consistent class set' distinction makes the two tools trivially separable.

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?

Explicit routing: use vw_apply_class_standard when you want a consistent set with colours and line weights, and use insert tools or vw_set_record when an object must actually be moved into the class. It also states what will NOT happen (active class unchanged, no object moved), which preempts the most likely misuse.

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