Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_list_hoists

Read-only

Inventories document hoists for rigging paperwork, sorted by location then ID, with capacity, hook height and truss data. Filter by design layer or location; read-only.

Instructions

Inventory of the hoists (BrxHoist objects) in the document for rigging paperwork. Reads only. Sorted by location then ID. Returns {count, total_capacity_kg, hoists: [{uuid, id, symbol, location, function, direction, capacity_kg, hook_height_mm, hook_height (as Vectorworks formats it), weight_with_chain, truss_system_top, truss_system_bottom, notes, class, layer, x, y}]}.

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_hoists"
  }
}

Input Schema

NameRequiredDescriptionDefault
layerNoOnly hoists on this design layer. Omitted: all layers.
locationNoOnly hoists whose Location text matches, case-insensitive. Omitted: all.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.2.0

TDQS

A3.7/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, so safety is covered; the description adds ordering semantics ("Sorted by location then ID") that the agent cannot get elsewhere. It stops short of covering result-size limits or empty-result behavior, which are the remaining behavioral unknowns for a list tool.

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 one-line purpose and read-only guarantee, then the sort order, then the return shape. The field enumeration is long but earns its place because no output schema exists; only minor redundancy appears in repeating the field name alongside its formatted variant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the inline {count, total_capacity_kg, hoists:[...]} contract is exactly the right compensation, and the sort order plus read-only note round it out. Remaining gaps are minor: no mention of maximum result size or what an empty hoist set looks like.

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 both filters (layer, location) are already fully documented in the schema, including case-insensitivity and the omitted-means-all default. The description adds no further parameter meaning, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Uses a specific verb ("Inventory") and a precise resource ("the hoists (BrxHoist objects) in the document"), and adds the domain purpose ("for rigging paperwork"). It does not explicitly name or contrast with adjacent list tools such as vw_list_truss, but the BrxHoist specificity makes the distinction inferable.

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?

Usage is only implied: "for rigging paperwork" and "Reads only" sketch the context, and the two optional filters hint at narrowing. There is no statement of when to prefer this over vw_list_truss, vw_find_objects, or vw_get_record, and no when-not guidance.

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