Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_import_resource

Import a symbol or plug-in style from a Vectorworks library file into the open document's resource list, keeping full record data. Places nothing in the drawing; insert afterward.

Instructions

Import one symbol or plug-in style from a library file into the open document. Goes through Vectorworks' own importer, so the resource arrives complete (a truss symbol brings its Braceworks record, a fixture symbol its Lighting Device data). Changes the document's resource list only; nothing is placed in the drawing. Afterwards place it with vw_insert_symbol (plain symbols) or the typed insert tools (truss runs, lighting devices). One revertible step: vw_revert_last removes the imported resource. Returns {name, type_code} with the name as it exists in the document.

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

Input Schema

NameRequiredDescriptionDefault
nameYesExact resource name inside that file (from vw_list_library).
pathYesAbsolute path of the library .vwx file (from vw_list_library).
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.
new_nameNoName for the imported copy when the document already has a resource called `name`. Omitted: imported under its own name.
type_codeNoResource type: 16 = symbol definition or plug-in style (default), 47 = record format.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.2.0
    • changedInput schema / properties / name / description
      Previous value: -"Exact resource name inside that file (from vw_list_library_resources)."New value: +"Exact resource name inside that file (from vw_list_library)."
    • changedInput schema / properties / path / description
      Previous value: -"Absolute path of the library .vwx file (from vw_list_library_files)."New value: +"Absolute path of the library .vwx file (from vw_list_library)."
  2. Changed5 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: +"Exact resource name inside that file (from vw_list_library_resources)."
    • addedInput schema / properties / new_name / description
      Added value: +"Name for the imported copy when the document already has a resource called `name`. Omitted: imported under its own name."
    • addedInput schema / properties / path / description
      Added value: +"Absolute path of the library .vwx file (from vw_list_library_files)."
    • addedInput schema / properties / type_code / description
      Added value: +"Resource type: 16 = symbol definition or plug-in style (default), 47 = record format."
  3. Added

TDQS

A4.6/5.0
Behavior5/5

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

Annotations only declare the generic write/safe/non-open-world profile; the description adds the substantive traits: the import runs through Vectorworks' own importer so attached records (Braceworks, Lighting Device data) come along, the mutation is confined to the document's resource list, and the change is a single revertible step. It even discloses the return shape {name, type_code} since 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.

Conciseness4/5

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

Front-loaded with the action, then consequences, then the follow-up step and the return value — a logical ordering with no filler sentences. It runs slightly long at six sentences and the parenthetical examples (truss/Braceworks, fixture/Lighting Device) could be tightened, but each sentence carries distinct information.

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 5-parameter write tool with no output schema, the description covers the mutation scope, side effects, reversibility, follow-up placement, and return shape. The only omission is the record-format type code, a minor schema-level detail rather than a gap in calling the tool 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 coverage is 100%, so the baseline applies and the schema already explains path, name, document, new_name and type_code in more detail than the description does. The description only brushes the return pair {name, type_code} and never mentions the type_code 47 record-format case, which the schema allows but the description's 'symbol or plug-in style' framing does not acknowledge.

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 ('Import one symbol or plug-in style from a library file into the open document') and immediately bounds the scope to a single resource. It is clearly separable from vw_insert_symbol and the typed insert tools, which it names as the follow-up step rather than the same action.

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 what this tool does not do ('nothing is placed in the drawing') and routes the agent onward: vw_insert_symbol for plain symbols, typed insert tools for truss runs and lighting devices. It also names vw_revert_last as the undo path and vw_list_library as the source of its parameters, so both the entry and exit of the workflow are covered.

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