Revit Model MCP

Overview Schema Source Related Servers Discussions Admin

Audit Families

revit_family_audit

Read-onlyIdempotent

Audit an open Revit family or named project families without saving or loading changes, and flag skipped entries when results are incomplete.

Instructions

Audit an open family or named project families without saving or loading changes. Project mode takes exact family names or ["*"]; family mode takes none. 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.
`families`	No
`process_id`	No	Revit process ID; takes precedence over document.
`timeout_seconds`	No

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed9 schema fields changedv0.10.0Oct 14, 2026

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 / families / title
```
Removed value: -"Families"
```

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

removedInput schema / properties / response_timeout_s

Removed value: -{
-  "default": 600,
-  "maximum": 3600,
-  "minimum": 30,
-  "title": "Response Timeout S",
-  "type": "integer"
-}

addedInput schema / properties / timeout_seconds

Added value: +{
+  "default": 600,
+  "maximum": 3600,
+  "minimum": 30,
+  "type": "integer"
+}

removedInput schema / title

Removed value: -"revit_family_auditArguments"

removedOutput schema / title

Removed value: -"revit_family_auditDictOutput"

Addedv0.7.0Sep 30, 2026

TDQS

A4/5.0

Behavior4/5

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

Beyond the readOnly/idempotent annotations, it discloses that the audit neither saves nor loads changes (a meaningful constraint for a family operation) and explains the incompleteness signal: a non-empty skipped list means the result is incomplete, with skippedCount tallying all skipped entries. This adds real behavioral context the annotations do not carry.

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 read-only scoping constraint and mode semantics front-loaded and no filler. Dense but each clause carries information; readable and efficiently sized for a 4-parameter tool.

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?

With an output schema present, return-value detail is unnecessary, and the description covers the operational modes, the no-save/no-load guarantee, and the skipped/skippedCount incompleteness semantics. Only the timeout and process_id/document precedence are left undocumented in prose, a minor gap.

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

Parameters4/5

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

Schema coverage is only 50%, so the description must compensate, and it does for the key `families` parameter: exact names or the ["*"] wildcard in project mode, none in family mode (implying it is optional). The document/process_id precedence and timeout parameter are left to the schema, which documents the former but not timeout_seconds.

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?

The description gives a specific verb+resource ('audit ... families') and disambiguates the two operating modes (open family vs named project families). It also implicitly separates itself from mutating siblings like revit_edit_families and revit_load_family via 'without saving or loading changes', though it never names an alternative tool explicitly.

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?

It states the two usage modes and what each expects: 'Project mode takes exact family names or ["*"]; family mode takes none.' That is clear contextual guidance on when each mode applies, but there is no explicit when-not or named alternative among the many sibling tools.

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

Deploy Server