Skip to main content
Glama

group_solids

Group or ungroup brushes in a VMF so Hammer treats members as one selectable unit while each solid keeps only one group ID.

Instructions

Puts brushes in one Hammer group, or takes them out of theirs. A group has no name: Hammer treats its members as one thing when you click any of them, and that is all it is. A solid carries exactly one group id, so grouping a brush that is already grouped moves it rather than adding a second id, which Hammer would read as whichever came first. read_map_organisation reads it back -- groups, and solidsInNoGroup. (The Python sidecar cannot: its writer emits 'groupid' and its parser looks for 'group', so anything going through it reports no group membership on any map. That is a caveat about the sidecar's own map reading, not about verifying this.)

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

Input Schema

NameRequiredDescriptionDefault
pathYesPath to the .vmf, absolute or relative to the repo root.
ownerNo'world', or a brush entity classname.
backupNoCopy the file to <file>.bak before writing. Nothing is copied on a no-op.
dryRunNoCheck and report without writing. Every verification runs either way.
withinNo
confirmNoRequired (true) to run this tool: it writes or executes.
ungroupNoTake the brushes out of their group instead.
materialNoBrushes carrying this on at least one face.
solidIdsNo

Output Schema

NameRequiredDescriptionDefault
pathYes
groupIdYes
writtenYes
nextStepYes
warningsYes
unchangedYes
backupPathYes
solidsChangedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.24-alpha

TDQS

A4.2/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 disclosure burden, and it delivers non-obvious behavior: a group is unnamed, a solid holds exactly one group id, and regrouping moves rather than duplicates because Hammer would otherwise read 'whichever came first.' It also flags a sidecar round-trip hazard. It does not discuss write atomicity or failure modes, which keeps it below 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 semantics are front-loaded and efficient, but the trailing sidecar parenthetical is long and tangential, spending several clauses on a caveat about another component's parser. Every sentence does carry information, yet the caveat could be compressed to a single clause without loss.

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 9-parameter mutation tool with a nested `within` object, the description covers the semantics that matter (group ownership, regrouping behavior, ungroup mode, verification path) and an output schema exists so return values need no explanation. What remains thin is error/failure behavior and how backup/dryRun interact with the write, both of which are only partially covered by schema text.

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

Parameters4/5

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

Schema coverage is 78%, so baseline is 3; the description adds genuine meaning beyond it by explaining the one-group-id-per-solid constraint that governs solidIds, and by defining the ungroup mode's effect on those ids. Parameters like owner, within, dryRun, and confirm are left entirely to the schema, so it is not a full 5.

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?

Opens with a specific verb and resource: 'Puts brushes in one Hammer group, or takes them out of theirs.' It also defines what a group is ('no name... Hammer treats its members as one thing') and names read_map_organisation as the read counterpart, so an agent can separate it from sibling inspectors without opening a 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?

Clearly signals the two modes (group vs. ungroup via the ungroup flag) and routes read-back to read_map_organisation with the specific fields to look for (`groups`, `solidsInNoGroup`). It does not state exclusions or prerequisites relative to the other mutation siblings (clip_solids, transform_solids, etc.), so it stops short of full when/when-not guidance.

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