Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_list_documents

Read-only

Lists open Vectorworks documents front to back and identifies the active drawing, helping you confirm which document every other tool will read or modify before making changes.

Instructions

List the documents open in Vectorworks, front to back, and which one is active.

Read-only; asks macOS from outside Vectorworks (no job, no Accessibility permission). Returns {documents: [names], active, paths: {name: path}} for the paths this server has learned. Every other tool works on the active document, so call this at session start and before writes; switch with vw_switch_document. Fails with "No document is open" when only the start screen shows.

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

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnlyHint and openWorldHint=false, but the description adds real behavioral context: the data is fetched by asking macOS from outside Vectorworks, so no job is dispatched and no Accessibility permission is needed. It also discloses the failure mode ('No document is open' when only the start screen shows), which is exactly the kind of edge case an agent needs.

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 purpose, then mechanism, then return shape, then usage and failure mode — a sensible order. It is dense with parentheticals (job/Accessibility, paths mapping), which slightly hurts scannability but each clause carries new 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?

With no output schema, the description compensates by spelling out the return shape {documents, active, paths} and its limits ('for the paths this server has learned'). Combined with the documented failure case and the session-start advice, an agent has everything needed to call and interpret it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

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

The tool takes zero parameters, so there is nothing to disambiguate and the baseline of 4 applies. The description does not waste space restating an empty schema.

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 (list documents), the ordering (front to back), and the extra datum returned (which one is active). This is immediately distinguishable from siblings like vw_list_layers or vw_list_classes despite the shared 'list' prefix.

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 explicit timing guidance ('call this at session start and before writes') and names the correct follow-up action ('switch with vw_switch_document'). It also supplies the precondition that every other tool operates on the active document, which is the real reason to call this first.

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