read_vmf
Inspect a .vmf map source to list entities, outputs, and brush counts without compiling; Hammer IDs are preserved so reported items can be found again in the editor.
Instructions
Entities, outputs and brush counts of a .vmf, reported without judgement. Use it to see what a map source contains; use read_vmf_lint to find what is wrong with it. Unlike a compiled .bsp, a VMF keeps Hammer ids, so anything reported here can be found again in the editor. Needs the Python sidecar; see health.
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"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| game | No | Game profile id. This fork supports only 'l4d2', which is also the default; any other id is refused rather than answered about the wrong game. | |
| path | Yes | Path to the .vmf, absolute or relative to the repo root. | |
| limit | No | ||
| classname | No | Restrict the entity list to one class. | |
| collapseInstances | No | Expand every func_instance first, the way vbsp does at compile time. A map using instances otherwise reads as one entity where there is a whole building: counts are far too low, and outputs crossing an instance look like they target nothing. Off by default because it changes every count and every targetname. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| game | Yes | ||
| path | Yes | ||
| counts | Yes | ||
| matched | Yes | ||
| entities | Yes | ||
| returned | Yes | ||
| histogram | Yes | ||
| instances | Yes |