Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_list_truss

Read-only

Lists truss systems and runs in a Vectorworks document, grouped in chain order with piece count, length, weight, symbols, positions, 3D centers and bounding boxes. Reads only; filter by layer or truss system.

Instructions

Inventory of the truss in the document, grouped by truss system in chain order. Reads only. Each system lists its pieces in order along the chain with count, total length and weight, symbols, position names, each piece's 3D centre and the run's plan bounding box (document units, independent of the current view); linked is False when a run's pieces are not chained. Returns {runs: [{system, count, total_length, total_weight_kg, positions, symbols, linked, bbox, pieces: [{uuid, symbol, length, center, class, layer}]}], total_pieces, total_length}.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "vw_list_truss"
  }
}

Input Schema

NameRequiredDescriptionDefault
layerNoOnly truss on this design layer. Omitted: all layers.
systemNoOnly this truss system, by its Braceworks name such as 'T2'. Omitted: every system.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.1
    • addedInput schema / properties / layer / description
      Added value: +"Only truss on this design layer. Omitted: all layers."
    • addedInput schema / properties / system / description
      Added value: +"Only this truss system, by its Braceworks name such as 'T2'. Omitted: every system."
  2. Added

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, and the description stays consistent ("Reads only"). Beyond that it adds genuine context: coordinates are in document units and independent of the current view, and `linked` is False when a run's pieces are not chained — an edge case an agent could not infer from annotations alone.

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 read-only constraint are front-loaded, followed by the return shape. The inline structure dump is dense and reads as a run-on block rather than a formatted shape, but nearly every clause carries information 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?

There is no output schema, yet the description fully enumerates the return object (runs, per-run fields, per-piece fields, and the totals) plus the units convention and the `linked` failure mode. Nothing material is missing for a two-optional-parameter read tool.

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 both the `layer` and `system` descriptions are precise about the omitted-means-all default. The description itself adds no filtering semantics beyond what the schema already says, so the baseline of 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?

The opening sentence states a specific verb and resource ("Inventory of the truss in the document") plus the organizing principle (grouped by truss system in chain order), which is distinct from siblings like vw_list_layers or vw_find_objects. An agent can tell exactly what this returns 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 Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

"Reads only" implies a safe inspection context, and the optional filters imply it can be scoped, but the description never says when to reach for this versus vw_find_objects or vw_list_positions. Usage is inferable rather than stated.

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