Skip to main content
Glama

read_map_organisation

Reads visgroups, groups and the cordon from a .vmf and reports which objects belong to each, counting membership from the objects so ids declared nowhere are flagged, not dropped.

Instructions

Visgroups, groups and the cordon of a .vmf, with what belongs to each. None of it reaches the compiled map -- a visgroup hides a brush from the editor and not from vbsp -- which is why it was invisible here and why it matters at scale: on a map with two thousand brushes, 'the north tenement' has to be a name that lives in the file or every selection is a bounding box someone typed from memory. Membership is counted from the objects rather than from the declarations, so an id used by a brush and declared nowhere is reported -- Hammer drops those silently when it opens the file.

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

Input Schema

NameRequiredDescriptionDefault
pathYesPath to the .vmf, absolute or relative to the repo root.

Output Schema

NameRequiredDescriptionDefault
pathYes
groupsYes
cordonsYes
warningsYes
visgroupsYes
cordonsActiveYes
solidsInNoGroupYesSolids carrying no groupid. This is the one group_solids moves.
solidsInNoVisgroupYesSolids carrying no visgroupid. A map with no visgroups reports all of them.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.24-alpha

TDQS

A3.6/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 full burden, and it delivers non-obvious semantics: this data never reaches the compiled map, membership is counted from objects rather than declarations, and dangling ids are reported rather than silently dropped as Hammer does. It omits error behavior such as a missing or malformed path, which keeps it from 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 opening sentence is well front-loaded, but the remainder is padded with rhetorical justification ('why it was invisible here', the two-thousand-brush tenement anecdote) that reads as advocacy rather than operative instruction. The substantive facts could be stated in half the words.

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 shape need not be explained, and the one required parameter is fully documented in the schema. What remains is covered: what is read, how membership is derived, and how undeclared ids are surfaced; only failure-mode behavior is absent.

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?

Single parameter with 100% schema description coverage, so the schema already explains 'path to the .vmf, absolute or relative to the repo root'. The description adds no further meaning about the path, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

First sentence names the specific resources read from a .vmf (visgroups, groups, cordon) and the added payload (membership per object). That is concrete enough to distinguish it from siblings like read_map_geometry or read_vmf, though no sibling is named as an explicit contrast.

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

Usage Guidelines3/5

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

Usage is only implied: you infer you call this when you need editor-side grouping or the cordon bounds. There is no explicit when-to-use rule, no when-not-to-use, and no pointer to an alternative tool for plain VMF inspection.

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