Skip to main content
Glama
sharafutdinovdi

Revit Model MCP

View Elements

revit_view_elements
Read-onlyIdempotent

Fetch paginated element rows from a chosen Revit view, including categories, families, types, levels, and measurements. Use this to inspect individual elements when summary counts are not enough.

Instructions

Read one page of elements in a selected view.

Returns data with elements, total, offset, limit and hasMore; rows include IDs, category, family, type, level and available measurements in mm, m2 and m3. No matches or an offset beyond the result return elements=[]; advance offset while hasMore=true. Prefer revit_view_summary for counts and category discovery; use this tool for individual rows and revit_element_details for all parameters. A missing document, unknown or unsupported view, read failure or timeout raises an error; partial data is not returned.

If more than one Revit instance is running, document is required; otherwise any instance may respond.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
viewYesRequired exact, case-sensitive non-template view name from revit_list_views, or its Revit view ID as a decimal string; no default. An exact name takes precedence over interpreting a numeric string as an ID.
limitNo
offsetNo
documentNoCase-insensitive substring of the target active document title or file name; default null leaves requests unaddressed, so any instance may respond. Use a unique substring with multiple instances; revit_list_instances instead returns all matching instances, or all instances when omitted.
categoriesNo
timeout_secondsNoPositive integer seconds to wait for a result after pickup (120 when omitted); HTTP uses this as its response budget. Expiry raises an error, and increasing it does not override the add-in's execution limits.
pickup_timeout_secondsNoPositive integer seconds to wait for the add-in to pick up a local or SSH job (300 when omitted); ignored over HTTP. A pickup timeout raises an error but the pending job may still execute later.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.1.1
    • addedInput schema / properties / document / description
      Added value: +"Case-insensitive substring of the target active document title or file name; default null leaves requests unaddressed, so any instance may respond. Use a unique substring with multiple instances; revit_list_instances instead returns all matching instances, or all instances when omitted."
    • addedInput schema / properties / pickup_timeout_seconds / description
      Added value: +"Positive integer seconds to wait for the add-in to pick up a local or SSH job (300 when omitted); ignored over HTTP. A pickup timeout raises an error but the pending job may still execute later."
    • addedInput schema / properties / timeout_seconds / description
      Added value: +"Positive integer seconds to wait for a result after pickup (120 when omitted); HTTP uses this as its response budget. Expiry raises an error, and increasing it does not override the add-in's execution limits."
    • addedInput schema / properties / view / description
      Added value: +"Required exact, case-sensitive non-template view name from revit_list_views, or its Revit view ID as a decimal string; no default. An exact name takes precedence over interpreting a numeric string as an ID."
  2. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the readOnlyHint/idempotentHint annotations, the description discloses return structure (elements, total, offset, limit, hasMore; row fields), pagination behavior (empty elements[] on no matches/offset beyond; advance offset while hasMore=true), and error semantics (raises error; partial data not returned). It also covers multi-instance fallback, adding substantial behavioral context.

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?

The description is well-structured, front-loading the purpose, then enumerating output format, pagination, alternatives, and error behavior. Each sentence contributes meaning, though it is relatively long. The organization makes it scannable.

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?

Given the tool has an output schema (not shown but flagged true) and 7 parameters, the description covers return format, pagination, error handling, and multi-instance behavior. It provides enough context for an agent to call the tool correctly, and the output schema handles return detail. No critical missing context.

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 57%, so the description must compensate for undocumented parameters. It explains offset pagination ('advance offset while hasMore=true') and document usage ('any instance may respond'), but does not describe the categories filter or limit semantics explicitly. Some value is added, but gaps remain for parameters like categories that have only a bare array schema.

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?

The description clearly states 'Read one page of elements in a selected view' – a specific verb and resource. It also distinguishes itself from siblings by noting 'Prefer revit_view_summary for counts and category discovery; use this tool for individual rows and revit_element_details for all parameters,' making it unambiguous what tool to pick.

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?

Explicit usage guidance is provided: it directs agents to revit_view_summary for counts/category discovery, and revit_element_details for all parameters. It also explains when the document parameter is required ('If more than one Revit instance is running, document is required'), offering concrete operational context.

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