Skip to main content
Glama

render_vmf_tour

Generate an automatic contact sheet of eye-height room and doorway views from a VMF to spot layout flaws in one look before compiling.

Instructions

Walks a .vmf and returns one picture of the whole place: a contact sheet of eye-height views, one per room and one from each side of every doorway, worked out from the map rather than from cameras you supply. This exists because of a measurement -- across three sessions in which cold agents built the same map end to end, render_vmf_view was called once between them, and the map that passed every check had a door painted flat on a wall, counters that were single boxes and no skirting anywhere. None of that is visible to any check and all of it is obvious in one look. Cameras stand where a player would, via the same floor-finding measure_vmf_clearance uses, so no frame is the inside of a slab. When the room pass finds nothing to walk it falls back to the spawn and an outside view, and says so rather than returning an empty sheet.

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

Input Schema

NameRequiredDescriptionDefault
fovNo
pathYesPath to the .vmf, absolute or relative to the repo root.
stepNoCell size for the room pass. Vary it if the rooms come out wrong; see building.md.
widthNoPer frame, not per sheet.
heightNo
maxCellsNo
minRoomAreaNoSquare units below which a region is not a room.

Output Schema

NameRequiredDescriptionDefault
pathYes
rowsYes
notesYes
viewsYes
columnsYes
omittedYes
pngBytesYes
roomCountYes
portalCountYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.24-alpha

TDQS

A3.9/5.0
Behavior4/5

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

With only a title annotation, the description carries the burden and does well: it discloses how cameras are placed (same floor-finding as measure_vmf_clearance, so no frame is inside a slab) and the failure path (falls back to spawn plus an outside view and reports that instead of an empty sheet). It does not say how many frames a large map may produce or anything about cost, which matters for a whole-map render.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose is front-loaded in sentence one, which is good, but the cold-agent measurement anecdote runs long and reads as justification rather than instruction. The operational content (camera derivation, fallback behavior) is buried after the narrative and could be tightened without losing meaning.

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 whole-map renderer the description covers what the agent most needs: what it returns at a high level, how viewpoints are chosen, and what happens on a degenerate map. With an output schema present, return details are legitimately omitted; the remaining gap is parameter-level guidance for the five partly- or undocumented knobs.

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

Parameters2/5

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

Schema description coverage is 57%, and the undocumented parameters (fov, height, maxCells) get nothing in the description either, so half the knobs are unexplained everywhere. The description's only conceptual tie-in is 'one per room', which vaguely relates to minRoomArea, and it says nothing about how fov, per-frame width/height, or the maxCells budget affect the sheet.

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 first sentence gives a concrete verb and resource ('Walks a .vmf') plus the exact output shape ('a contact sheet of eye-height views, one per room and one from each side of every doorway'), and immediately distinguishes itself from the camera-driven sibling by saying it works 'from the map rather than from cameras you supply'. An agent can tell this apart from render_vmf_view 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 a clear triggering condition: things that pass every check can still look wrong (flat doors, box counters, missing skirting) and are obvious in one look, which tells the agent this is a visual sanity pass after rule checks. It does not explicitly name render_vmf_view or render_vmf_plan as the alternative for camera-specified or top-down views, so the routing guidance is implied rather than stated.

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