Revit Model MCP

Overview Schema Source Related Servers Discussions Admin

Links Status

revit_links_status

Read-onlyIdempotent

Check RVT, CAD, and image link status before export or hand-over, returning summary counts plus paths, status, and instance counts for each link.

Instructions

Read RVT, CAD and image link status before an export or hand-over.

Returns data with summary counts and rvtLinks, cadLinks and images lists containing status, paths and instance counts. Each list is capped at 100 entries by ID without pagination; summary counts cover all entries. No links produce empty lists; per-entry failures appear in error with status Other. A missing active document, overall read failure or timeout raises an error; timeout partials are not returned.

If more than one Revit instance is running, document is required; otherwise any instance may respond. Non-empty skipped means the answer is incomplete; skippedCount includes entries beyond the first 100.

Input Schema

TableJSON Schema

Name	Required	Description
`document`	No	Case-insensitive substring of the target active document title or file name. Reads require exactly one matching instance; omitted document requires exactly one running instance. Zero or multiple matches fail before publishing. revit_list_instances returns all matching instances, or all running instances when omitted.
`process_id`	No	Exact positive Revit process ID. Takes precedence over document; if both are supplied they must agree.
`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.

Changed2 schema fields changedv0.7.0Sep 30, 2026

changedInput schema / properties / document / description

Previous 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."New value: +"Case-insensitive substring of the target active document title or file name. Reads require exactly one matching instance; omitted document requires exactly one running instance. Zero or multiple matches fail before publishing. revit_list_instances returns all matching instances, or all running instances when omitted."

addedInput schema / properties / process_id

Added value: +{
+  "anyOf": [
+    {
+      "type": "integer"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "Exact positive Revit process ID. Takes precedence over document; if both are supplied they must agree.",
+  "title": "Process Id"
+}

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.4/5.0

Behavior5/5

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

Goes well beyond the readOnly/idempotent/destructive annotations by disclosing the 100-entry cap without pagination, that summary counts cover all entries, empty-list behavior, per-entry failures surfacing in error with status Other, error semantics for missing document/read failure/timeout, and that timeout partials are not returned. It also explains the skipped/skippedCount meaning, which is exactly the kind of behavioral detail an agent needs.

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?

Purpose is front-loaded in the first sentence, followed by well-organized output and error behavior paragraphs. It is dense and slightly long, with some clauses (e.g. 'timeout partials are not returned') that border on redundant, but nearly every sentence carries operational value.

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?

For a read-only status tool with four optional parameters and an output schema, the description covers output shape, caps, error/failure modes, and multi-instance routing. Despite the output schema existing, the added return-value context is genuinely useful rather than filler.

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 all four parameters (document, process_id, timeout_seconds, pickup_timeout_seconds) are already fully documented, including precedence and timeout semantics. The description mentions the document requirement for multi-instance cases but adds no new parameter meaning beyond the schema, so the baseline 3 applies.

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 ('Read RVT, CAD and image link status') and frames the scope around an export or hand-over workflow. It is clearly distinguishable from siblings such as revit_compare_link_datums, revit_remove_links and revit_align_link_datums, which mutate or compare rather than read status.

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?

Gives a clear usage context ('before an export or hand-over') and explains the preconditions for the read via the multi-instance/document rule. However, it never names a concrete alternative tool or an explicit when-not-to-use condition, so routing is inferred rather than stated.

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

Deploy Server