Skip to main content
Glama
BIM Viewer MCP Server

BIM Viewer MCP Server

Highlight elements

highlight_elements
Read-onlyIdempotent

Highlights specified building elements in place in the 3D viewer without moving the camera, so users can visually identify query results.

Instructions

Highlight a set of building elements in the 3D viewer, in place.

The elements are colored where they stand; the camera does NOT move. Invalid or duplicate ids are dropped. Use this to show an answer visually; use zoom_to afterward only if the user asks to zoom.

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": {
      "external_ids": "<external_ids>"
    },
    "name": "highlight_elements"
  }
}

Input Schema

NameRequiredDescriptionDefault
external_idsYesRevit UniqueIds (the viewer's externalIds) of elements to highlight. Shape: 8-4-4-4-12 hex GUID, hyphen, 8 hex digits.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnly, idempotent, non-destructive, but the description adds behavior they cannot express: elements are colored where they stand, the camera does not move, and invalid or duplicate ids are silently dropped. That last point is exactly the kind of error-handling disclosure an agent needs before passing ids, so the description earns credit beyond the annotation bar.

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 short sentences, front-loaded with the core action, then the visual invariant, then the routing rule. No filler or restatement of the title.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists and annotations carry the safety profile, so the description only needs the visual/camera semantics and id-handling, both of which it supplies. Nothing required to invoke it correctly is missing.

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% and the single external_ids parameter is documented with an exact GUID shape in the schema itself. The description adds no further parameter meaning, so the baseline 3 is appropriate.

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 ("Highlight a set of building elements") plus a scope qualifier ("in the 3D viewer, in place"). The phrase "in place" plus the camera note separates it from zoom_to and from isolate/reset siblings without needing their schemas.

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

Usage Guidelines5/5

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

Gives explicit when-to-use ("show an answer visually") and names the alternative with its triggering condition ("use zoom_to afterward only if the user asks to zoom"). The exclusion is conditional and actionable, not vague.

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