Skip to main content
Glama
Vectorworks MCP

Vectorworks MCP

vw_create_sheet

Create a printable presentation sheet with a Top/Plan viewport of chosen design layers, custom scale, hidden classes, and an optional title block.

Instructions

Create a presentation sheet: a sheet layer with one Top/Plan viewport of chosen design layers and an optional title block. Use it to make a printable plot page; vw_create_layer makes a bare layer only. The viewport shows layers at 1:scale with hide_classes hidden in that viewport. With title, sheet_number or project, a Title Block Border is placed at the sheet origin and those fields written where the title block style has them. The user's active layer is restored. One revertible step: vw_revert_last deletes the sheet with its viewport and title block. Returns {sheet, viewport (uuid), title_block: {uuid, fields_set, fields_unknown, fields_available}?, title_block_error?}. To look at it, the user switches to the sheet and you call vw_screenshot, or use vw_render_layers for a picture.

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>",
      "layers": "<layers>"
    },
    "name": "vw_create_sheet"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesName of the new sheet layer. Fails if a layer of that name exists.
scaleNoViewport scale denominator: 48 = 1/4" = 1'-0", 96 = 1/8", 50 or 100 for metric. Must be positive.
titleNoSheet title written into the title block's 'Sheet Title' field. Any of title, sheet_number or project adds a Title Block Border.
layersYesDesign layer names the viewport shows; at least one.
projectNoProject name written into the title block's 'Project Name' field.
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.
hide_classesNoClass names hidden in this viewport only, for example ['Notes', 'Lighting-Focus Points']. Omitted: all classes visible.
sheet_numberNoSheet number written into the title block's 'Sheet Number' field.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 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 / hide_classes / description
      Added value: +"Class names hidden in this viewport only, for example ['Notes', 'Lighting-Focus Points']. Omitted: all classes visible."
    • addedInput schema / properties / layers / description
      Added value: +"Design layer names the viewport shows; at least one."
    • addedInput schema / properties / name / description
      Added value: +"Name of the new sheet layer. Fails if a layer of that name exists."
    • addedInput schema / properties / project / description
      Added value: +"Project name written into the title block's 'Project Name' field."
    • addedInput schema / properties / scale / description
      Added value: +"Viewport scale denominator: 48 = 1/4\" = 1'-0\", 96 = 1/8\", 50 or 100 for metric. Must be positive."
    • addedInput schema / properties / sheet_number / description
      Added value: +"Sheet number written into the title block's 'Sheet Number' field."
    • addedInput schema / properties / title / description
      Added value: +"Sheet title written into the title block's 'Sheet Title' field. Any of title, sheet_number or project adds a Title Block Border."
  2. Added

TDQS

A4.6/5.0
Behavior4/5

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

Annotations only declare it is a non-destructive write, so the description carries most of the load and does well: it discloses the active-layer restore side effect and that the whole operation is one revertible step whose revert deletes sheet, viewport and title block. It stops short of stating permission requirements or what happens if a listed design layer does not exist.

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 core action and tightly written with no filler; the return-shape and revert sentences are information-dense rather than padded. It is long, but the length is justified by the tool's composite behavior.

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?

Despite having no output schema, the description spells out the return payload including optional title_block fields and title_block_error, plus the revert and verification paths. For a create tool with 8 parameters, an agent has everything needed to invoke and follow up correctly.

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?

Schema coverage is 100%, so the baseline is 3, but the description adds cross-parameter meaning the schema cannot: the viewport renders 'layers' at 1:'scale' with 'hide_classes' hidden in that viewport only, and any of title/sheet_number/project triggers a Title Block Border at the sheet origin with fields written where the style supports them.

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 composite resource: 'Create a presentation sheet: a sheet layer with one Top/Plan viewport of chosen design layers and an optional title block.' It explicitly contrasts with the sibling vw_create_layer ('makes a bare layer only'), so the agent can distinguish the two without opening either schema.

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 an explicit use case ('make a printable plot page') and names the alternative plus the condition that selects it. It also routes follow-up work: vw_revert_last to undo, vw_screenshot after the user switches to the sheet, or vw_render_layers for a picture.

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