Revit Model MCP

Overview Schema Source Related Servers Discussions Admin

Document Info

revit_document_info

Read-onlyIdempotent

Retrieve key details from the active Revit model, including file name, version, levels, area schemes, worksets, and view count. Use this to understand the model's structure before further analysis.

Instructions

Read general information about the active Revit model.

Returns data with file name, Revit version, levels (elevations in mm), area schemes, worksets and view count. Absent collections are empty; non-workshared models have no worksets. Call revit_list_views next for view analysis. A missing active document, 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

Name	Required	Description
`document`	No	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.
`timeout_seconds`	No	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.
`pickup_timeout_seconds`	No	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.

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv0.1.1Sep 15, 2026

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."

First observedSep 15, 2026

TDQS

A4.5/5.0

Behavior5/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is covered. The description adds meaningful behavioral detail beyond that: absent collections are empty, non-workshared models have no worksets, errors are raised on missing documents/read failures/timeouts, and partial data is not returned. It also explains multi-instance behavior, which is important for correct invocation.

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?

The description is well structured and front-loaded: purpose, returned data, edge cases, follow-up tool, errors, and multi-instance behavior each have a compact sentence. There is no filler or redundant restatement of the tool name, and every sentence contributes useful information.

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 annotations, full parameter schema, and output schema, the description covers the remaining behavioral essentials: return content, empty collection semantics, error behavior, partial data prevention, and multi-instance routing. An agent has enough information to select and invoke this tool correctly without inference gaps.

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 the schema already documents all three parameters in detail INRThe description adds only general context about document selection and does not materially extend parameter semantics. With full schema coverage, the baseline of 3 is appropriate because the schema carries the parameter-documentation burden.

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 opens with a specific verb and resource: 'Read general information about the active Revit model.' It then enumerates exactly what will be returned: file name, Revit version, levels, area schemes, worksets, and view count. This clearly distinguishes it from siblings like revit_list_views, and explicitly routes to that tool for view analysis.

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

Usage Guidelines4/5

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

The description gives clear usage context, including the instruction to call revit_list_views next for view analysis and the multi-instance guidance about requiring the document parameter. The document parameter schema also points to revit_list_instances for listing all instances. It lacks an explicit 'do not use when...' exclusion, but the guidance is otherwise strong.

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

Deploy Server