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