Skip to main content
Glama
bimq

bimq

by aec-platform

Quantity roll-up

bim_quantity_rollup
Read-only

Totals a named quantity over a filtered selection, grouped by type, storey or PredefinedType, and flags groups where some elements lack that quantity so partial totals are visible.

Instructions

Total a named quantity (NetSideArea, GrossVolume, Length, ...) over a selection, grouped by type, storey or PredefinedType. Lengths, areas and volumes are already converted to m, m2 and m3.

Every group reports without_quantity next to count. A total computed over 40 of 200 walls is not a total, and the caller is told so rather than left to assume the model was complete.

Input Schema

NameRequiredDescriptionDefault
typeNoEntity type, e.g. IfcDoor. Subtypes included by default.
storeyNoStorey name or GlobalId. Substring match on the name.
group_byNoHow to group the totals.type
quantityYesQuantity name, e.g. NetSideArea.
name_containsNoCase-insensitive substring of the element name.
predefined_typeNoPredefinedType / surfaceType value, e.g. FIRE_RATED.
include_subtypesNoMatch subtypes of `type`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint, openWorldHint=false), and the description adds genuinely non-obvious behavior: unit normalization to m/m2/m3 and, crucially, that each group reports `without_quantity` alongside `count` so incomplete totals are self-evident. It does not say what happens when the named quantity is absent everywhere or on error, keeping 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.

Conciseness4/5

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

Opens with the operation and grouping before any caveat, which is the right ordering. The second paragraph's aphorism about 40 of 200 walls is slightly editorial but does justify the `without_quantity` field, so it mostly earns its space.

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?

With no output schema, the description carries the return-value burden and does so for the main fields (group key, count, without_quantity). It stops short of describing the shape of group labels or behavior on unknown quantity names, but an agent has enough to call it correctly.

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 100%, so every parameter is already documented in the schema, and the description adds only the example quantity names and the unit-conversion note. Baseline 3 is appropriate since the schema does the heavy lifting.

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 ('Total a named quantity ... over a selection') plus the grouping axis, which is more precise than any sibling like bim_model_summary or bim_property_values. An agent can tell this is the aggregation tool versus the listing/detail tools without opening the schema.

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?

The description implies when to use it (you want a rolled-up total rather than per-element values) and names the grouping options, but never states exclusions or points to an alternative such as bim_property_values for distinct values or bim_elements_by_type for per-element listings. Usage is inferable rather than directed.

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