Revit Model MCP

Overview Schema Source Related Servers Discussions Admin

List Instances

revit_list_instances

Read-onlyIdempotent

List running Revit processes with document name/path, version, process ID, and plugin responsiveness; filter by document when multiple models are open.

Instructions

List Revit processes with documentName, documentPath, revitVersion, processId and pluginResponding. Busy or unresponsive processes stay listed with pluginResponding=false. HTTP mode reports only its connected process.

Input Schema

Name	Required	Description	Default
`document`	No	Title or file name substring of the target document; needed when several Revit instances run.

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 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 / title

Removed value: -"revit_list_instancesArguments"

removedOutput schema / title

Removed value: -"revit_list_instancesDictOutput"

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

addedOutput schema / additionalProperties
```
Added value: +true
```

removedOutput schema / properties

Removed value: -{
-  "result": {
-    "items": {
-      "additionalProperties": true,
-      "type": "object"
-    },
-    "title": "Result",
-    "type": "array"
-  }
-}

removedOutput schema / required
```
Removed value: -[
-  "result"
-]
```

changedOutput schema / title

Previous value: -"revit_list_instancesOutput"New value: +"revit_list_instancesDictOutput"

Changed1 schema field 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."

First observedSep 15, 2026

TDQS

A3.5/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 genuine non-obvious behavior: busy or unresponsive processes remain listed with pluginResponding=false, and HTTP mode returns only the connected process — real edge-case context beyond the structured fields.

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 short sentences, front-loaded with what is listed, then the edge-case behavior. Little waste; the field enumeration is slightly redundant with the output schema but still readable and helpful.

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 no explanation, and annotations cover safety. The description complements these with edge-case and mode-specific behavior, leaving only usage routing unaddressed for a simple read-only list tool.

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 sole optional 'document' parameter is fully documented in the schema itself. The description enumerates output fields (documentName, processId, etc.) rather than adding meaning to the input parameter, so baseline 3 applies.

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 ('List') and resource ('Revit processes'), plus the exact fields returned (documentName, documentPath, revitVersion, processId, pluginResponding). This distinguishes it from document-oriented siblings like revit_documents, but it never explicitly names an alternative, so sibling differentiation is implied rather than stated.

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

Usage Guidelines2/5

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

There is no explicit when-to-use or when-not-to-use guidance, nor any named alternative such as revit_documents or revit_jobs. The only hint at context is the schema note about 'needed when several Revit instances run', which lives in the parameter, not the description.

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

Deploy Server