Skip to main content
Glama

render_vmf_plan

Render a dimensioned floor plan from a .vmf to show where rooms, doorways, and measured distances are, returning both an image and SVG from one description.

Instructions

A dimensioned floor plan of a .vmf: a horizontal cut taken above the floor, with room outlines, floor areas, the width written on every doorway, a grid, a scale bar and a north arrow. render_vmf_view says what a place looks like from somewhere; this says WHERE things are, and it is the drawing you can measure with. Returns the picture to look at and the SVG to keep, both from one description, so the two cannot disagree. Anything entirely above or below the cut is not on the drawing -- a raised walkway, a sunken pit -- so the cut height is always reported.

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": "render_vmf_plan"
  }
}

Input Schema

NameRequiredDescriptionDefault
svgNoAlso return the SVG text. It can be long.
cutZNoHeight of the cut. Default: 48 units above the lowest floor a person can stand on.
gridNoGrid spacing, and the scale bar's length.
pathYesPath to the .vmf, absolute or relative to the repo root.
roomsNoOutline rooms and dimension the doorways.
seedsNo
widthNo
heightNo

Output Schema

NameRequiredDescriptionDefault
svgYes
cutZYes
pathYes
notesYes
roomsYes
portalsYes
pngBytesYes
pageWidthYes
roomCountYes
brushesCutYes
pageHeightYes
unitsPerPixelYes
sectionAreaUnitsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.24-alpha

TDQS

A4.1/5.0
Behavior4/5

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

Annotations carry only a title, so the description bears the burden and does real work: it discloses what is excluded from the drawing (raised walkways, sunken pits), that the cut height is always reported, and that the raster picture and SVG come from one description so they cannot disagree. It stops short of covering cost, file/size caveats for large SVGs, or what happens on an invalid .vmf.

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?

The identity and purpose are front-loaded in the first clause, followed by content, sibling differentiation and the cut-plane caveat in a logical order. Slightly florid phrasing ('the drawing you can measure with', 'the picture to look at and the SVG to keep') costs a little density but each sentence carries information.

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?

For a read-only render with an output schema present, the description covers what is produced, the main semantic caveat, and its relationship to a sibling. The remaining omission is the undocumented geometry/size parameters, which is a modest gap rather than a blocking one.

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?

Against 63% schema description coverage, the description adds genuine meaning for cutZ (the cut plane and its exclusion consequence) and for svg ('Returns the picture to look at and the SVG to keep'), plus the grid-and-scale-bar linkage. However, seeds, width and height receive no explanation in either place, leaving a real gap for 3 of 8 parameters.

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 description names a specific verb and artifact: a 'dimensioned floor plan of a .vmf', a horizontal cut above the floor with room outlines, floor areas, doorway widths, grid, scale bar and north arrow. It also explicitly contrasts with the sibling render_vmf_view ('says what a place looks like' vs 'says WHERE things are'), so an agent can separate 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 Guidelines4/5

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

It gives the selecting condition against render_vmf_view ('the drawing you can measure with', i.e. use this when you need positions and measurable dimensions rather than a viewpoint). It also states the domain limitation that objects entirely above or below the cut are absent. No explicit when-not-to-use or prerequisite guidance beyond that.

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