Revit Model MCP

Overview Schema Source Related Servers Discussions Admin

Model Snapshot

revit_model_snapshot

Read-onlyIdempotent

Read a schema version 1 project snapshot for batch audits; a non-empty skipped list or skippedCount signals incomplete results from closed worksets.

Instructions

Read a schema version 1 project snapshot for batch audits. Closed worksets can make the result incomplete. A non-empty skipped list means the result is incomplete; skippedCount counts all skipped entries.

Input Schema

Name	Required	Description
`document`	No	Title or file name substring of the target document; needed when several Revit instances run.
`process_id`	No	Revit process ID; takes precedence over document.
`parameter_rules`	No
`timeout_seconds`	No	Seconds to wait for a result (default 120).
`pickup_timeout_seconds`	No	Seconds to wait for the add-in to pick up the job (default 300); unused over HTTP.

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed14 schema fields changedv0.10.0Oct 14, 2026

removedInput schema / $defs / ParameterRule / properties / category / title
```
Removed value: -"Category"
```
removedInput schema / $defs / ParameterRule / properties / parameter / title
```
Removed value: -"Parameter"
```
removedInput schema / $defs / ParameterRule / title
```
Removed value: -"ParameterRule"
```

changedInput schema / properties / document / description

Previous 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."New value: +"Title or file name substring of the target document; needed when several Revit instances run."

removedInput schema / properties / document / title
```
Removed value: -"Document"
```
removedInput schema / properties / parameter_rules / title
```
Removed value: -"Parameter Rules"
```

changedInput schema / properties / pickup_timeout_seconds / description

Previous 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."New value: +"Seconds to wait for the add-in to pick up the job (default 300); unused over HTTP."

removedInput schema / properties / pickup_timeout_seconds / title
```
Removed value: -"Pickup Timeout Seconds"
```

changedInput schema / properties / process_id / description

Previous value: -"Exact positive Revit process ID. Takes precedence over document; if both are supplied they must agree."New value: +"Revit process ID; takes precedence over document."

removedInput schema / properties / process_id / title
```
Removed value: -"Process Id"
```

changedInput schema / properties / timeout_seconds / description

Previous 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."New value: +"Seconds to wait for a result (default 120)."

removedInput schema / properties / timeout_seconds / title
```
Removed value: -"Timeout Seconds"
```

removedInput schema / title

Removed value: -"revit_model_snapshotArguments"

removedOutput schema / title

Removed value: -"revit_model_snapshotDictOutput"

Addedv0.7.0Sep 30, 2026

TDQS

A3.7/5.0

Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds genuinely non-obvious behavioral context: closed worksets can degrade results and a non-empty skipped list / skippedCount signals an incomplete snapshot.

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?

Three compact sentences with the core purpose front-loaded and no filler. The incomplete-result caveat is repeated in two variants (skipped list and skippedCount), which is slightly redundant but justified by the different output signals.

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

Completeness4/5

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

An output schema exists, so the description is not required to explain return values, yet it usefully flags the incompleteness signal an auditor needs. Combined with 80% parameter coverage and full annotations, an agent has enough to invoke this correctly; no explicit sibling routing is the only gap.

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 80%, so the schema already documents document, process_id, and the timeouts adequately; baseline 3 applies. The description explains output concepts (skipped list, skippedCount) rather than adding meaning to any input parameter such as parameter_rules.

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 and resource ('Read a schema version 1 project snapshot') and adds a scope qualifier ('for batch audits'), which is more than a restatement of the name. It does not, however, explicitly distinguish itself from batch-oriented siblings like revit_batch_fetch or revit_batch_status.

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

Usage Guidelines3/5

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

'for batch audits' implies the context in which this tool applies, but there is no explicit when-to-use guidance, no when-not, and no named alternative. The agent must infer the boundary between this and other batch tools.

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

Deploy Server