Skip to main content
Glama

read_brush_volumes

Read bounding boxes for every brush entity in a compiled BSP, grouped by classname, to size rooms, shop fronts, and areaportal openings when a spec needs floor area rather than a guess.

Instructions

Footprint and volume of every brush entity in a compiled map, grouped by classname. Each func_* entity owns a brush model (*N in lump 14) whose bounding box this reads. Use it to size the built environment -- shop fronts, rooms behind a func_door, areaportal openings -- when a spec needs a floor area rather than a guess. It reports bounding boxes, not true volumes: an L-shaped room measures as its enclosing box.

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

Input Schema

NameRequiredDescriptionDefault
pathYesPath to the .bsp, absolute or relative to the repo root.
limitNo
classnameNoRestrict to one classname, e.g. func_door.

Output Schema

NameRequiredDescriptionDefault
pathYes
byClassYes
largestYes
attributedYesModels an entity claims through its `model` key.
brushModelsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.24-alpha

TDQS

A3.9/5.0
Behavior3/5

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

Annotations carry only a title, so the description bears the full behavioral burden. It does well on the output caveat (bounding boxes, L-shaped rooms measure as enclosing boxes) and on the underlying mechanism, but never states read-only/safety behavior, cost, or scope limits for large maps, leaving real gaps for an unannotated tool.

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?

Four compact sentences, front-loaded with what is returned, then mechanism, then use case, then the accuracy caveat. Every sentence carries information; only the lump-14 detail is arguably incidental for an agent choosing the tool.

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?

An output schema exists, so return-value details need not be in the description. Combined with the stated caveat and use cases, an agent has enough to call it correctly; the remaining gap is pagination/limit behavior for large maps.

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?

Schema coverage is 67%, so the schema documents path and classname but leaves limit only partly described. The description adds nothing about limit (default 50, max 1000) or about how classname grouping interacts with the filter, so it does not compensate for the coverage gap.

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: reads footprint and volume of every brush entity in a compiled map, grouped by classname. It also self-differentiates by explaining the brush-model/lump-14 mechanism and by explicitly distinguishing its output from 'true volumes', so an agent knows this is not the same as a general extents or entity dump.

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?

Gives concrete when-to-use context -- sizing shop fronts, rooms behind a func_door, areaportal openings -- and the selection condition ('when a spec needs a floor area rather than a guess'). It does not name a sibling alternative or state when not to use it, so it stops short of full routing guidance.

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