Revit Model MCP

Overview Schema Source Related Servers Discussions Admin

Audit Families

revit_family_audit

Read-onlyIdempotent

Audit open Revit families or named project families in a live model without saving or loading changes. Check unused shared parameters for schedule or tag data.

Instructions

Audit an open family or named project families without saving or loading changes.

In project mode, pass exact names or ["*"]. In family mode, omit families. Unused shared parameters may still carry schedule or tag data in the project.

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.
`families`	No
`process_id`	No	Exact positive Revit process ID. Takes precedence over document; if both are supplied they must agree.
`response_timeout_s`	No

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Addedv0.7.0Sep 30, 2026

TDQS

A4/5.0

Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so safety is covered. The description adds genuinely useful behavior beyond that: it does not save or load changes, multi-instance resolution rules, and importantly that a non-empty skipped set means an incomplete answer with skippedCount truncated past 100 entries.

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?

Front-loaded purpose followed by compact mode and multi-instance rules; every sentence carries operational weight. Formatting across blank lines is slightly ragged but no content is wasted.

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?

Output schema exists so return values need not be described, and the description still explains key return semantics (skipped/skippedCount). For a 4-param, zero-required, read-only audit tool whose annotations cover safety, this is nearly complete; only the untimed timeout parameter and truncation limit detail are missing.

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?

With 50% schema coverage, two parameters lack schema descriptions. The description compensates meaningfully for families (exact names or ["*"], omit in family mode) and reinforces document's multi-instance requirement. It is silent on response_timeout_s and the maxItems=200 vs 'first 100' interaction, keeping it from a 5.

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 (Audit) and resource (families), plus distinguishes two modes (open family vs named project families). It does not name or contrast a sibling tool, but an agent can still tell it apart from edit-family or query tools by the read-only audit framing.

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?

Explicitly tells the agent how to invoke each mode: exact names or ["*"] in project mode, omit families in family mode, and use document when multiple Revit instances run. It gives operational context but does not name when to prefer this over sibling tools like revit_edit_families or revit_parameter_fill_check.

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

Deploy Server