@rui.branco/revit-mcp 1.0.5 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -16,46 +16,56 @@ and nothing to copy by hand.
|
|
|
16
16
|
|
|
17
17
|
## Installation
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Do this on the PC that has Revit. Takes about a minute.
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
### 1. Add the plugin
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
> through a listener bound to `127.0.0.1`, so a cloud session or another
|
|
25
|
-
> computer cannot see it.
|
|
26
|
-
|
|
27
|
-
**Claude Desktop** — through Settings, not the chat box:
|
|
28
|
-
|
|
29
|
-
1. **Settings → Plugins → Add ▾ → Add marketplace → Add from a repository**
|
|
30
|
-
2. Enter `rui-branco/revit-mcp`
|
|
31
|
-
3. Install **revit** from the marketplace that appears
|
|
32
|
-
|
|
33
|
-
**Claude Code** — slash commands in the CLI:
|
|
23
|
+
**Claude Cowork and Claude Code** — type these two lines:
|
|
34
24
|
|
|
35
25
|
```
|
|
36
26
|
/plugin marketplace add rui-branco/revit-mcp
|
|
37
27
|
/plugin install revit@revit-tools
|
|
38
28
|
```
|
|
39
29
|
|
|
30
|
+
**Claude Desktop**
|
|
31
|
+
|
|
32
|
+
1. **Settings → Plugins → Add → Add marketplace → Add from a repository**
|
|
33
|
+
2. Paste `rui-branco/revit-mcp`
|
|
34
|
+
3. Click **Install** on **Revit**
|
|
35
|
+
|
|
36
|
+
### 2. Restart Revit
|
|
37
|
+
|
|
38
|
+
Revit shows a security warning about an unsigned add-in the first time. Click
|
|
39
|
+
**Always Load**. If you click *Do Not Load*, Revit remembers it and nothing will
|
|
40
|
+
work.
|
|
41
|
+
|
|
42
|
+
### 3. Check it
|
|
43
|
+
|
|
44
|
+
Open a model and ask Claude: *"run revit_status"*. It should answer with your
|
|
45
|
+
Revit version and the open file.
|
|
46
|
+
|
|
47
|
+
That's it. The plugin updates itself, so you never download anything again.
|
|
48
|
+
|
|
40
49
|
<details>
|
|
41
|
-
<summary>
|
|
50
|
+
<summary>Good to know</summary>
|
|
42
51
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
52
|
+
**It only works on the PC running Revit.** Claude talks to Revit through your
|
|
53
|
+
own computer, so it cannot reach a Revit on another machine. That also means a
|
|
54
|
+
normal Claude Desktop chat cannot use it — use Cowork or Claude Code, which run
|
|
55
|
+
on your PC.
|
|
47
56
|
|
|
48
|
-
|
|
57
|
+
**The Revit add-in installs itself** the first time the server starts, so
|
|
58
|
+
there is no separate install step. If that ever fails, ask Claude to *install
|
|
59
|
+
the Revit bridge* and it will do it on demand. To turn the automatic install
|
|
60
|
+
off, set `REVIT_MCP_NO_AUTO_INSTALL=1`.
|
|
49
61
|
|
|
50
|
-
|
|
51
|
-
nothing to re-download when a new version ships; in Claude Code,
|
|
52
|
-
`/plugin update` pulls it early if you do not want to wait.
|
|
62
|
+
</details>
|
|
53
63
|
|
|
54
64
|
<details>
|
|
55
|
-
<summary
|
|
65
|
+
<summary>Other ways to install</summary>
|
|
56
66
|
|
|
57
|
-
|
|
58
|
-
|
|
67
|
+
The plugin above is the supported path, and the only one that updates on its
|
|
68
|
+
own.
|
|
59
69
|
|
|
60
70
|
**Claude Code, without the plugin**
|
|
61
71
|
|
|
@@ -96,80 +106,6 @@ arguments and needs no environment beyond the optional
|
|
|
96
106
|
|
|
97
107
|
</details>
|
|
98
108
|
|
|
99
|
-
### 2. Install the Revit add-in — automatic
|
|
100
|
-
|
|
101
|
-
Nothing to do. The server installs the add-in itself the first time it starts:
|
|
102
|
-
it looks for `RevitMcpBridge.addin` in
|
|
103
|
-
`%APPDATA%\Autodesk\Revit\Addins\<version>\` and, when no Revit has it, copies
|
|
104
|
-
the bundled add-in and its manifest into place for every Revit it finds. That
|
|
105
|
-
runs in the background on Windows, so it never delays or breaks the server, and
|
|
106
|
-
once the add-in is there it does nothing at all.
|
|
107
|
-
|
|
108
|
-
**If it is turned off or fails**, ask Claude to **install the Revit bridge**.
|
|
109
|
-
That runs `revit_install_bridge` — the same installer, on demand. Revit need not
|
|
110
|
-
be running, and re-running is safe. Auto-install is off whenever
|
|
111
|
-
`REVIT_MCP_NO_AUTO_INSTALL` is set; see [Configuration](#configuration).
|
|
112
|
-
|
|
113
|
-
Either way the add-in is only on disk at this point. Revit does not load it
|
|
114
|
-
until it restarts, which is step 3.
|
|
115
|
-
|
|
116
|
-
### 3. Restart Revit and approve the add-in
|
|
117
|
-
|
|
118
|
-
Revit scans the Addins folder only at startup. On first load it shows a
|
|
119
|
-
**"Security - Unsigned Add-In"** dialog for `RevitMcpBridge` — this is expected,
|
|
120
|
-
the add-in is not code-signed. Choose **Always Load**; *Do Not Load* is
|
|
121
|
-
remembered and the bridge will never start.
|
|
122
|
-
|
|
123
|
-
### 4. Verify
|
|
124
|
-
|
|
125
|
-
Open a model and ask Claude to run `revit_status`. It reports the bridge
|
|
126
|
-
version, Revit version and active document, confirming the chain end to end.
|
|
127
|
-
|
|
128
|
-
<details>
|
|
129
|
-
<summary><b>Installing manually, or uninstalling</b></summary>
|
|
130
|
-
|
|
131
|
-
From the package's `revit-bridge` directory:
|
|
132
|
-
|
|
133
|
-
```powershell
|
|
134
|
-
.\install.ps1
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
| Flag | Effect |
|
|
138
|
-
| --- | --- |
|
|
139
|
-
| `-RevitVersion 2026` | Only that version, even outside the default Program Files location. |
|
|
140
|
-
| `-Build` | Compile a fresh add-in with `dotnet build -c Release`. Needs the .NET SDK. |
|
|
141
|
-
| `-SkipBuild` | Never build. Already the default when the bundled add-in is present. |
|
|
142
|
-
| `-Uninstall` | Remove the manifest and the install folder. |
|
|
143
|
-
| `-Json` | Emit one JSON result object as the only stdout output — the mode the MCP tools use. |
|
|
144
|
-
|
|
145
|
-
Exit codes: `0` success, `1` unhandled failure, `2` no Revit found, `3` no
|
|
146
|
-
supported Revit version, `4` build failed or .NET SDK missing, `5` no add-in to
|
|
147
|
-
install. Runs under Windows PowerShell 5.1 and PowerShell 7.
|
|
148
|
-
|
|
149
|
-
To uninstall: ask Claude to uninstall the Revit bridge
|
|
150
|
-
(`revit_uninstall_bridge`) and restart Revit, then `claude mcp remove revit` or
|
|
151
|
-
delete the entry from `claude_desktop_config.json`.
|
|
152
|
-
|
|
153
|
-
</details>
|
|
154
|
-
|
|
155
|
-
<details>
|
|
156
|
-
<summary><b>Version support and prerequisites</b></summary>
|
|
157
|
-
|
|
158
|
-
| | |
|
|
159
|
-
| --- | --- |
|
|
160
|
-
| **OS** | Windows (Revit has no macOS build) |
|
|
161
|
-
| **Revit** | 2025, 2026 or 2027 |
|
|
162
|
-
| **Node.js** | 18 or newer |
|
|
163
|
-
| **.NET SDK** | Not required — only to build the C# side yourself |
|
|
164
|
-
|
|
165
|
-
One prebuilt add-in covers all three Revit versions: it is compiled against the
|
|
166
|
-
Revit 2025 reference assemblies, which load unchanged in 2026 and 2027. Tested
|
|
167
|
-
end to end against Revit 2027.3. **Revit LT is unsupported** (no add-in API) and
|
|
168
|
-
**2024 and earlier are refused** (.NET Framework 4.8 cannot load a
|
|
169
|
-
`net8.0-windows` assembly).
|
|
170
|
-
|
|
171
|
-
</details>
|
|
172
|
-
|
|
173
109
|
## Usage
|
|
174
110
|
|
|
175
111
|
With a model open in Revit, ask in plain language:
|
package/package.json
CHANGED
|
Binary file
|
|
Binary file
|