Skip to main content
Glama

read_bsp_info

Reads the header of a compiled .bsp to return its ident, version, mapRevision build stamp, and all lump offsets and sizes. Inspect map structure instantly by parsing only the first 1036 bytes.

Instructions

Header of a compiled .bsp: ident, version, mapRevision and all 64 lumps with their offset and size. Reads only the first 1036 bytes, so it is instant even on a 1 GB map. mapRevision is the build stamp a compiled map carries.

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

Input Schema

NameRequiredDescriptionDefault
pathYesPath to the .bsp, absolute or relative to the repo root.
allLumpsNoInclude empty lumps (default: only lumps with content).

Output Schema

NameRequiredDescriptionDefault
pathYes
identYes
lumpsYes
versionYes
fileSizeYes
lumpCountYes
hdrLightingYesWhether vrad produced HDR lighting, from lumps 53/54/58 being present. NOT from lump 56: LEAF_AMBIENT_LIGHTING is per-visleaf ambient and exists in LDR maps too, so reading it as HDR reports every LDR map as HDR-compiled.
mapRevisionYesThe compiled map's build stamp.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.24-alpha

TDQS

A3.6/5.0
Behavior3/5

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

Annotations carry no hints (only a title), so the description must do the work, and it does disclose a real behavioral trait: only the first 1036 bytes are read and the call is effectively instant regardless of map size. It does not state that the operation is read-only in so many words, nor how it behaves on a missing/invalid .bsp, so gaps remain.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences, front-loaded with what the tool returns, followed by cost and a one-line gloss of mapRevision. Every sentence carries information and nothing is padded.

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 description covers scope, cost, and a key field's meaning. It leaves out failure modes (non-.bsp file, bad path) and never mentions the allLumps option, which are small but real omissions for a file-reading tool with no annotations.

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 description coverage is 100%, so both path and allLumps are already documented, and the description adds nothing beyond that (it never mentions the allLumps toggle or path resolution). 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?

The description names a specific resource and scope ('Header of a compiled .bsp') and enumerates exactly what it returns (ident, version, mapRevision, all 64 lumps with offset and size), so an agent can tell this apart from deeper .bsp readers like read_bsp_entities. It stops short of explicitly naming which sibling to use when, which keeps it from a 5.

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: 'Reads only the first 1036 bytes, so it is instant even on a 1 GB map' signals this is a cheap first-pass/validation call, but there is no explicit when-to-use or when-not-to-use versus read_bsp_entities or the report tools.

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