Skip to main content
Glama

revit_set_busy

Set the Revit MCP HUD busy indicator and background color to signal active AI agent operations, with optional message, activity, document, and port details.

Instructions

Sets the visual busy indicator and background color of the Revit MCP HUD.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
busyNo
portNo
messageNo
activityNo
doc_nameNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.8/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden, yet it only states that visual state is set. It does not disclose whether this affects one or many instances (the 'port' parameter implies multi-instance targeting), whether state persists, or any side effects. This leaves significant gaps for a state-mutating tool.

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?

A single front-loaded sentence with no wasted words that states the core action immediately. Appropriately sized for the surface-level claim it makes.

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

Completeness2/5

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

Although an output schema exists (so return values need not be described), the 0% parameter coverage and absence of annotations mean the description should explain the five parameters and behavioral traits but does not. It is far too thin for a five-parameter mutating tool.

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

Parameters2/5

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

Schema description coverage is 0% across five parameters, so the description must compensate. It only obliquely maps to 'busy' and mentions a 'background color' that has no corresponding parameter, leaving port, message, activity, and doc_name entirely unexplained.

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?

States a specific verb ('Sets') and resource ('visual busy indicator and background color of the Revit MCP HUD'), which is clearly distinct from siblings like revit_capture_screenshot or revit_ping. It does not explicitly differentiate itself from siblings, but the HUD/UI-state domain makes its role unambiguous.

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

Usage Guidelines2/5

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

The description offers no when-to-use guidance, no prerequisites, and does not mention any alternative or related tool. An agent has no signal for when toggling the busy indicator is appropriate versus other Revit tools.

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