Skip to main content
Glama

read_vmf_surfaces

Classify .vmf faces into floors, walls, ceilings, and slopes, measure exposed surface area, and map brush contacts to identify buried geometry before compiling.

Instructions

Every face of a .vmf sorted into floor, wall, ceiling and slope, with how much of each a person could actually touch -- and which brush touches which. A map is boxes pushed against each other, so most of what a .vmf contains is buried: the underside of every slab, the back of every wall. Counting those doubles a building's floor area in a number that reads perfectly ordinary. Exposure is measured by probing along each face's own normal. Note that 'exposed' means open space in front, which includes the outside of the map: a ceiling slab's upper face is the roof.

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

Input Schema

NameRequiredDescriptionDefault
kindNoany
pathYes
limitNo
materialNoOnly faces whose material contains this.
exposedOnlyNo

Output Schema

NameRequiredDescriptionDefault
pathYes
facesYes
notesYes
matchedYes
faceCountYes
buriedCountYes
touchingBrushesYes
exposedAreaByKindYes
exposedAreaSquareMetresByKindYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.24-alpha

TDQS

B3.4/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 load and does well: it discloses that exposure is measured by probing along each face's normal and that 'exposed' includes the outside of the map, with the roof example. It omits read-only confirmation, cost, and result-size behavior, keeping it short of a 5.

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 core capability is front-loaded, but the middle sentences ('A map is boxes pushed against each other...') are discursive scene-setting that delays the operational facts. It is readable but not tight.

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

Completeness3/5

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

An output schema exists, so return values need no explanation, and the exposure semantics are well covered. However, for a five-parameter tool with low schema coverage, the absence of any parameter guidance leaves the definition incomplete for correct invocation.

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 only 20%, so the description should compensate, but it never mentions path, kind, limit, or material. It only indirectly illuminates exposedOnly by explaining what 'exposed' means, leaving four of five parameters unexplained in both places.

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: it sorts every face of a .vmf into floor/wall/ceiling/slope, measures touchable exposure, and reports brush attribution. The exposure-probing concept clearly separates it from raw readers like read_vmf and from read_vmf_solids.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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

The description explains why the tool exists (avoiding double-counted buried faces) but never says when to choose it over siblings such as read_vmf_solids or read_vmf_visibility, nor any prerequisites. Usage is only inferable from the rationale.

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