aec-model-bridge
Independent Revit MCP ( Model Context Protocol integration for Revit software ).
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Check it deeper on your machine
It has changed since its scan on 17 Nov 2026.
As a Claude Code plugin, install it and then ask Claude Code:
/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/Sam-AEC/aec-model-bridge with scanskillsafety
Or from a terminal, clone it and run it:
git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/Sam-AEC/aec-model-bridge'
It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.
Badge for your README
Markdown
[](/listings/sam-aec--aec-model-bridge)HTML
<a href="/listings/sam-aec--aec-model-bridge"><img src="/api/listings/sam-aec--aec-model-bridge/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
**In 60 seconds, without Revit (mock mode)**
1. Install [uv](https://docs.astral.sh/uv/getting-started/installation/). 2. Add the server to your client with the JSON under Manual setup and set `"MCP_REVIT_MODE": "mock"`. The one-click buttons below start in `bridge` mode, which needs Revit. 3. Restart the client and ask it to list the AEC Model Bridge tools. 4. Ask it to read the active document. Mock mode returns generated sample data, never your model, so the answers are a way to see the tools and the approval flow before you connect Revit. 5. For your own model, install the Revit add-in ([install steps](#install-the-revit-add-in)) and switch the mode to `bridge`.
**One-click install**
The buttons need [uv](https://docs.astral.sh/uv/getting-started/installation/) and nothing else. The server uses `~/Documents/AEC Model Bridge` as its workspace unless you set your own. For Claude Desktop, download the `.mcpb` file from the latest release and open it. Live Revit work still needs Revit and [the add-in](#install-the-revit-add-in). Mock mode needs neither.
**Manual setup**
For live Revit automation you need Windows, a licensed Revit 2024 to 2027, Python 3.11 or newer, [uv](https://docs.astral.sh/uv/getting-started/installation/), and the Revit add-in ([install steps](#install-the-revit-add-in)). Then add this to your `claude_desktop_config.json` (Codex, Cursor and VS Code use the same values; the two directory variables are optional and default to the workspace above):
{
"mcpServers": {
"aec-model-bridge": {
"command": "uvx",
"args": [
"--from",
"git+https://github.com/Sam-AEC/aec-model-bridge#subdirectory=packages/mcp-server-revit",
"aec-model-bridge"
],
"env": {
"MCP_REVIT_MODE": "bridge",
"MCP_REVIT_WORKSPACE_DIR": "C:\\RevitProjects",
"MCP_REVIT_ALLOWED_DIRECTORIES": "C:\\RevitProjects"
}
}
}
}Want to look at the tools first, without Revit? Set `"MCP_REVIT_MODE": "mock"`. The server then starts on any machine, lists every tool with its schema and returns canned responses. It does not touch a model. A `Dockerfile` for the same mock mode is in the repository root (`docker build -t aec-model-bridge .`, then `docker run -i --rm aec-model-bridge`).
Using VS Code? The [extension source and local install steps](extensions/vscode/README.md) register the MCP server and show the Revit connection status. It has not been published to the Marketplace.
Tools at a glance
| Area | Tools | What they do | | --- | --- | --- | | Revit | 110 | Read the model, create and edit elements, parameters, views, sheets, schedules, exports, worksharing | | Approval | 5 | Plan, review, approve, execute and roll back model changes | | Modules | 108 | Snapshot inspection, parameter grids, QA/QC checks, recipes, reports, selections | | Rhino and Grasshopper | 19 | Geometry, layers, materials, boolean operations | | Speckle | 17 | Projects, models, versions, send and receive | | Navisworks | 15 | Model tree, viewpoints, clash tests (in progress) | | IFC | 7 | Read IFC files without Revit: structure, properties, validation | | Graph, snapshots, exports, jobs | 21 | Semantic graph audits, snapshot diffs, SQLite export, background jobs |
302 tools are listed in the default setup (counted from the current server in mock mode). The Autodesk Data tools appear when APS credentials are configured. The [tool reference](docs/tools-generated.md) lists every tool. Each tool carries MCP annotations (`readOnlyHint`, `destructiveHint`, `idempotentHint`, `openWorldHint`), so clients can tell reads from writes.
Advanced Revit automation
Alongside model queries and parameter updates, Revit tools create building elements, views, sheets, schedules, tags and dimensions, and export IFC, DWG, images and Navisworks files. See the [tool reference](docs/tools-generated.md) for supported operations and inputs.
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
.claude-plugin/marketplace.json · Manifest · 21 lines
- {
- "name": "aec-model-bridge",
- "owner": {
- "name": "A. Sam Mohammad",
- "url": "https://github.com/Sam-AEC"
- },
- "metadata": {
- "description": "AEC Model Bridge for Claude Code: read an open Revit model and propose changes that a person approves first."
- },
- "plugins": [
- {
- "name": "aec-model-bridge",
- "source": "./plugin",
- "description": "Revit MCP server with an approval gate, plus a skill for the safe read, check, propose, approve flow.",
- "version": "1.5.0",
- "license": "GPL-3.0-or-later",
- "homepage": "https://github.com/Sam-AEC/aec-model-bridge",
- "keywords": ["revit", "bim", "aec", "mcp", "autodesk"]
- }
- ]
- }
README.md · README · 569 lines
- <div align="center">
- <img src="assets/logo.svg" alt="AEC Model Bridge logo: an isometric model cube with a bridge arch" height="120">
- **English** | [简体中文](docs/i18n/README.zh-CN.md) | [Español](docs/i18n/README.es.md) | [हिन्दी](docs/i18n/README.hi.md) | [العربية](docs/i18n/README.ar.md) | [Português (BR)](docs/i18n/README.pt-BR.md) | [Русский](docs/i18n/README.ru.md) | [日本語](docs/i18n/README.ja.md) | [Deutsch](docs/i18n/README.de.md) | [Français](docs/i18n/README.fr.md) | [Bahasa Indonesia](docs/i18n/README.id.md) | [Türkçe](docs/i18n/README.tr.md) | [한국어](docs/i18n/README.ko.md) | [Tiếng Việt](docs/i18n/README.vi.md) | [Italiano](docs/i18n/README.it.md) | [Polski](docs/i18n/README.pl.md) | [繁體中文](docs/i18n/README.zh-TW.md)
- **Ask your AI about the Revit model you have open. By default, write tools are blocked until you approve a plan.**
- Open-source MCP server and native add-in for Revit 2024 – 2027. Works with Claude, Codex and other MCP clients.
- [](https://github.com/Sam-AEC/aec-model-bridge/actions/workflows/ci.yml)
- [](https://github.com/Sam-AEC/aec-model-bridge/releases/latest)
- [](#supported-revit-versions)
- [](LICENSING.md)
- [Get started](#quick-start) | [Example workflows](#example-workflows) | [Tools](docs/tools-generated.md) | [Documentation](#documentation) | [Download](https://github.com/Sam-AEC/aec-model-bridge/releases/latest)
- </div>
- Status: on the dev branch, not yet released.
- <p align="center">
- <img src="docs/images/readme/revit-villa-panel.png" alt="Revit villa model beside the AEC Model Bridge panel with Dev mode enabled." width="900">
- </p>
- AEC Model Bridge is the open-source Revit MCP server that lets Claude, Codex,
- Cursor and other AI assistants read and edit your open Revit model. By default
- you approve every change first. It has two parts: a Python MCP server and a
- native Revit add-in. Read-only tools inspect the model straight away. Model
- changes need an approved plan by default.
- [See the approval flow](#how-approval-works).
- **Who it is for.** BIM coordinators and managers who want an AI assistant to
- check model quality, find affected elements and prepare parameter fixes, while a
- person stays in control of every change. You do not need to write scripts.
- **Status and limits.** This is pre-release software.
- - Bounded read-only checks in Revit 2024 are recorded in the
- [live validation report](docs/revit-addin-live-validation-2026-10-14.md).
- These checks do not establish that writes, rollback, recovery or other Revit
- years work. Those paths still need live acceptance. The Python server also
- has automated tests; CI builds do not start Revit. See the
- [release checklist](docs/release-checklist.md).
- - This page describes the dev branch. The latest GitHub release may not include
- everything described here.
- - Try it on a copy of a project first. Approving a plan changes the open model.
- - Some limits are known and listed under [How approval works](#how-approval-works)
- and in [docs/security.md](docs/security.md).
- ## Star History
- <a href="https://www.star-history.com/?repos=sam-aec%2Faec-model-bridge&type=date&legend=top-right">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=sam-aec/aec-model-bridge&type=date&theme=dark&legend=bottom-right" />
- <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=sam-aec/aec-model-bridge&type=date&legend=bottom-right" />
- <img alt="Star History Chart" src="https://api.star-history.com/chart?repos=sam-aec/aec-model-bridge&type=date&legend=bottom-right" />
- </picture>
- </a>
- Setup is documented for Claude Desktop, VS Code with GitHub Copilot, Cursor and
- Codex. The server is a standard MCP stdio server, so other clients such as
- Claude Code, Windsurf, Cline, Continue, Zed and Gemini CLI should work too. The
- [compatibility](docs/compatibility.md) page lists what is documented and what
- is untested.
- The same server also inspects IFC files, automates Rhino and Grasshopper, and
- connects to Speckle. [Integration status](#other-integrations) shows which
- providers are available and which are still in progress.
- ## Example workflows
- For BIM coordinators: check model quality, review the affected elements,
- approve a parameter fix, then check the result and export a report. These
- examples use tools in the [current catalog](docs/tools-generated.md).
- | Workflow | Example request | Tools used |
- | --- | --- | --- |
- | Model review | "Show the active document, list its warnings and find affected elements." | `revit_get_document_info`, `revit_get_warnings`, `revit_get_elements_by_type` |
- | Parameter updates | "Find walls on Level 02, show their Comments values, and propose a batch update." | `revit_get_elements_by_type`, `revit_get_element_parameters`, `revit_batch_set_parameters` |
- | Drawing production | "Prepare a sheet list from this CSV, then propose creating the sheets and placing the views." | `revit_batch_create_sheets_from_csv`, `revit_place_viewport_on_sheet` |
- | IFC review | "Show this IFC file's storeys, inspect the wall properties and report schema validation issues." | `ifc_get_spatial_structure`, `ifc_get_properties`, `ifc_validate` |
- For a first run in Revit, try:
- ```text
- Read the active model's warnings. Group them by description and show the
- affected element IDs. Then suggest which issues to investigate first.
- ```
- Then try a parameter correction, replacing the level and value for your project:
- ```text
- Find walls on Level 02 and show their current Comments values. Propose setting
- Comments to "Coordination reviewed" for the elements I choose. After I approve
- the plan in Revit, apply it and read the values back to confirm the result.
- ```
- For edits, the assistant creates a plan with `plan_actions`. You review it in
- the Revit panel, and only then does `execute_plan` apply it. IFC review runs
- without Revit.
- The snapshot QA/QC and report modules need a compatible saved snapshot. The
- handoff from Revit to these modules currently needs the filename and workspace
- to match. If you leave out `snapshot_id`, most of these modules now refuse in
- bridge mode with a clear message, and return generated sample data only in mock
- mode. Not every module has that guard yet (`model_bloat` does not), so always
- pass `snapshot_id`. For live inspection, use the direct Revit tools above.
- [Planned fixes and demo](docs/roadmap.md).
- ## Quick start
- **In 60 seconds, without Revit (mock mode)**
- 1. Install [uv](https://docs.astral.sh/uv/getting-started/installation/).
- 2. Add the server to your client with the JSON under Manual setup and set
- `"MCP_REVIT_MODE": "mock"`. The one-click buttons below start in `bridge`
- mode, which needs Revit.
- 3. Restart the client and ask it to list the AEC Model Bridge tools.
- 4. Ask it to read the active document. Mock mode returns generated sample
- data, never your model, so the answers are a way to see the tools and the
- approval flow before you connect Revit.
- 5. For your own model, install the Revit add-in
- ([install steps](#install-the-revit-add-in)) and switch the mode to
- `bridge`.
- **One-click install**
- [](docs/install-buttons.md#vs-code)
- [](https://cursor.com/en/install-mcp?name=aec-model-bridge&config=eyJjb21tYW5kIjoidXZ4IiwiYXJncyI6WyItLWZyb20iLCJnaXQraHR0cHM6Ly9naXRodWIuY29tL1NhbS1BRUMvYWVjLW1vZGVsLWJyaWRnZSNzdWJkaXJlY3Rvcnk9cGFja2FnZXMvbWNwLXNlcnZlci1yZXZpdCIsImFlYy1tb2RlbC1icmlkZ2UiXSwiZW52Ijp7Ik1DUF9SRVZJVF9NT0RFIjoiYnJpZGdlIn19)
- [](https://github.com/Sam-AEC/aec-model-bridge/releases/latest)
- The buttons need [uv](https://docs.astral.sh/uv/getting-started/installation/)
- and nothing else. The server uses `~/Documents/AEC Model Bridge` as its
- workspace unless you set your own. For Claude Desktop, download the `.mcpb`
- file from the latest release and open it. Live Revit work still needs Revit and
- [the add-in](#install-the-revit-add-in). Mock mode needs neither.
- **Manual setup**
- For live Revit automation you need Windows, a licensed Revit 2024 to 2027,
- Python 3.11 or newer, [uv](https://docs.astral.sh/uv/getting-started/installation/), and the Revit add-in
- ([install steps](#install-the-revit-add-in)). Then add this to your
- `claude_desktop_config.json` (Codex, Cursor and VS Code use the same values;
- the two directory variables are optional and default to the workspace above):
- ```json
- {
- "mcpServers": {
- "aec-model-bridge": {
- "command": "uvx",
- "args": [
- "--from",
- "git+https://github.com/Sam-AEC/aec-model-bridge#subdirectory=packages/mcp-server-revit",
- "aec-model-bridge"
- ],
- "env": {
- "MCP_REVIT_MODE": "bridge",
- "MCP_REVIT_WORKSPACE_DIR": "C:\\RevitProjects",
- "MCP_REVIT_ALLOWED_DIRECTORIES": "C:\\RevitProjects"
- }
- }
- }
- }
- ```
- Want to look at the tools first, without Revit? Set `"MCP_REVIT_MODE": "mock"`.
- The server then starts on any machine, lists every tool with its schema and
- returns canned responses. It does not touch a model. A `Dockerfile` for the same mock
- mode is in the repository root (`docker build -t aec-model-bridge .`, then
- `docker run -i --rm aec-model-bridge`).
- Using VS Code? The [extension source and local install steps](extensions/vscode/README.md)
- register the MCP server and show the Revit connection status. It has not been
- published to the Marketplace.
- ### Tools at a glance
- | Area | Tools | What they do |
- | --- | --- | --- |
- | Revit | 110 | Read the model, create and edit elements, parameters, views, sheets, schedules, exports, worksharing |
- | Approval | 5 | Plan, review, approve, execute and roll back model changes |
- | Modules | 108 | Snapshot inspection, parameter grids, QA/QC checks, recipes, reports, selections |
- | Rhino and Grasshopper | 19 | Geometry, layers, materials, boolean operations |
- | Speckle | 17 | Projects, models, versions, send and receive |
- | Navisworks | 15 | Model tree, viewpoints, clash tests (in progress) |
- | IFC | 7 | Read IFC files without Revit: structure, properties, validation |
- | Graph, snapshots, exports, jobs | 21 | Semantic graph audits, snapshot diffs, SQLite export, background jobs |
- 302 tools are listed in the default setup (counted from the current server in mock
- mode). The Autodesk Data tools appear when APS credentials are configured. The
- [tool reference](docs/tools-generated.md) lists every tool. Each tool carries
- MCP annotations (`readOnlyHint`, `destructiveHint`, `idempotentHint`,
- `openWorldHint`), so clients can tell reads from writes.
- ### Advanced Revit automation
- Alongside model queries and parameter updates, Revit tools create building
- elements, views, sheets, schedules, tags and dimensions, and export IFC, DWG,
- images and Navisworks files. See the [tool reference](docs/tools-generated.md)
- for supported operations and inputs.
- For anything the tool catalog does not cover, `revit_invoke_method`,
- `revit_reflect_get` and `revit_reflect_set` work with public Revit API members.
- `revit_execute_python` runs IronPython inside Revit. These advanced tools have
- the same permissions as the Revit process. Use them only with MCP clients and
- prompts you trust.
- ## How it works
- The MCP client talks to one Python hub. The hub sends each call to the
- provider that owns the tool. Providers for desktop apps talk to a small add-in
- inside that app over localhost.
- <p align="center">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="docs/images/architecture-dark.png">
- <img src="docs/images/architecture-light.png" alt="Architecture of AEC Model Bridge: an MCP client such as Claude or Codex calls the Python MCP hub, which routes tool calls to the Revit, Rhino, Navisworks, IFC and Speckle providers. The Revit and Rhino providers talk to add-ins over localhost HTTP, the IFC provider reads IFC files with IfcOpenShell, and Navisworks is still in progress." width="900">
- </picture>
- </p>
- <sub>Diagram source: [architecture.mmd](docs/diagrams/architecture.mmd). Regenerate the images with `python scripts/render_diagrams.py`.</sub>
- Teal boxes work today. The amber dashed boxes are in progress. Indigo
- shapes are data and external services.
- ### How approval works
- In plain words:
- - **Two modes you will use.** `look_only` lets the assistant read but refuses
- every tool that changes the model. `ask_first` (the default, also written
- `required`) lets it draft changes, but nothing runs until a person approves.
- A third value, `auto`, switches the check off and is meant only for
- controlled pipelines.
- - **Only a person approves.** Approving, rejecting and rolling back plans are
- not offered to AI clients. A person approves in the Revit panel or with the
- `aec-model-bridge-approve` command.
- - **Nothing applies on its own.** A change runs only if it matches an approved
- action of an approved plan, once.
- - **Undo is per action.** Revit's Ctrl+Z undoes one action per press.
- The hub stops any tool call that changes the model unless it carries an
- approved plan. The AI proposes a plan, you review it, and the add-in runs it on
- Revit's main thread. The panel's Plans list shows each pending plan's tools,
- arguments and, when one was captured, the before-value. When a plan carries
- review text (reasoning, citations, assumptions or warnings), the card offers
- "Show the review to enable Approve" and requires you to open it before approval.
- Malformed, unsupported or oversized reviews block approval. If the panel cannot
- show the approved content completely, it disables Approve and points to
- `aec-model-bridge-approve show <plan_id>` for the full plan. See
- [plan review in the panel](docs/security.md#plan-review-in-the-panel).
- This UI is covered by automated browser checks; live WebView2 approval still
- needs acceptance. Parameter and model-edit actions each run in their own named
- transaction; some actions (save, sync, scripts) do not, so Ctrl+Z does not
- cover them.
- <p align="center">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/Sam-AEC/aec-model-bridge/main/docs/images/readme/readme-workflow-dark.png">
- <img src="https://raw.githubusercontent.com/Sam-AEC/aec-model-bridge/main/docs/images/readme/readme-workflow-light.png" alt="Inspect, Propose, Approve, Verify. Four steps: inspect finds an empty Mark, propose drafts a change, approve is a human decision, verify reads the value back. Example values are illustrative." width="900">
- </picture>
- </p>
- <p align="center">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="docs/images/approval-flow-dark.png">
- <img src="docs/images/approval-flow-light.png" alt="Approval flow: the AI assistant drafts a plan with plan_actions, the side panel shows the proposed changes (counts, scope, before and after), and a human approves in the panel or with the aec-model-bridge-approve CLI, never over MCP. The hub checks that the plan matches the approved tool and arguments, once only. Revit then runs each action in its own transaction, so Ctrl+Z undoes one action per press. If you reject or never approve, the call is blocked and the model stays untouched." width="900">
- </picture>
- </p>
- <sub>Diagram source: [approval-flow.mmd](docs/diagrams/approval-flow.mmd). Regenerate the images with `python scripts/render_diagrams.py`.</sub>
- If a plan turns out wrong, undo it with Revit's Ctrl+Z. Each parameter write is
- its own named transaction, so one plan can take several presses. A one-step undo
- for a whole plan is planned, not built. A second route is a revert plan: the
- assistant drafts one with `plan_revert` from the proof of an executed plan, and
- you approve it like any other plan. `rollback_plan` also writes the recorded
- before-values back in reverse order and can skip an action when no before-value
- was recorded, but it is for people only and has no panel button or command-line
- command yet, so do not count on it. None of these paths is verified in a live
- Revit session yet (UNVERIFIED). Operations that cannot be reversed, such as
- file output, are not undone by any of them and do not get a second confirmation
- yet (planned). The panel's Plans list shows pending plans only; `aec-model-bridge-approve show <plan_id>`
- works for a plan in any state, while `proofs/` bundles exist only for plans that
- were executed (or attempted). The lifecycle is in
- [ADR 0008](docs/0008-approval-gate-lifecycle.md).
- For unattended pipelines you can set `MCP_REVIT_APPROVAL_MODE=auto`. That turns
- the human check off, so use it only in a controlled environment.
- ## Supported Revit versions
- | Revit version | Add-in target | Build tools |
- |---|---|---|
- | 2024 | .NET Framework 4.8 | .NET 8 SDK and .NET Framework 4.8 developer pack |
- | 2025 | .NET 8 for Windows | .NET 8 SDK |
- | 2026 | .NET 8 for Windows | .NET 8 SDK |
- | 2027 | .NET 10 for Windows | .NET 10 SDK |
- These are the build targets. CI compiles the add-in for all four years, but no
- year has been verified in a live Revit session yet.
- You also need Windows 10 or 11, Python 3.11 or later, and a licensed Revit
- installation for the version you use. Mock mode runs the server without Revit,
- which is useful for development and tests.
- ### Other integrations
- | Integration | Status |
- |---|---|
- | Revit | Available. Native C# add-in. |
- | IFC (IfcOpenShell) | Available. Reads IFC files without Revit running. |
- | Rhino and Grasshopper | Available. Connects to the Rhino add-in on `localhost:3004`. |
- | Speckle | Available. Needs a Speckle client ID in your environment. |
- | Navisworks Manage | In progress. The provider and its tools are registered. The Navisworks add-in is not finished. |
- | Power BI | In progress. The provider and tool exist but are not registered in the hub. |
- | Excel, Parquet and DuckDB | Planned. |
- Product names and logos belong to their owners. The banner uses them only to show what this project works with.
- ## Install the Revit add-in
- **Easiest (Windows):** download `AECModelBridge-Setup-<version>.exe` from the [latest release](https://github.com/Sam-AEC/aec-model-bridge/releases/latest), double-click it, pick your Revit versions and restart Revit. It installs the add-in and the bundled Python server. If you tick the box, it also sets up Claude Desktop and VS Code, and it backs up your current settings first. Uninstall it from Windows Settings. The steps below are for building from source.
- You install two parts: the Python MCP server and the Revit add-in. Live Revit
- automation needs both.
- ### 1. Install the MCP server
- ```powershell
- git clone https://github.com/Sam-AEC/aec-model-bridge.git
- cd aec-model-bridge
- py -m venv .venv
- .\.venv\Scripts\Activate.ps1
- python -m pip install -e packages/mcp-server-revit
- ```
- ### 2. Install the Revit add-in
- Set the version to match your Revit installation. If Windows blocks the
- downloaded scripts, right-click each `.ps1` file, open Properties, and select
- Unblock before running them.
- ```powershell
- $RevitVersion = Read-Host "Revit year (2024, 2025, 2026, or 2027)"
- .\scripts\package.ps1 -RevitVersion $RevitVersion
- .\scripts\install.ps1 -RevitVersion $RevitVersion
- ```
- The installer places version-specific binaries in:
- ```text
- C:\ProgramData\AECModelBridge\bin\<year>
- ```
- The add-in manifest is installed per user in:
- ```text
- %APPDATA%\Autodesk\Revit\Addins\<year>
- ```
- Use `-AllUsers` with `install.ps1` to install the manifest under
- `C:\ProgramData\Autodesk\Revit\Addins\<year>` instead.
- To prepare binaries for every supported version in one pass:
- ```powershell
- .\scripts\package.ps1 -RevitVersion All
- ```
- Each [GitHub release](https://github.com/Sam-AEC/aec-model-bridge/releases/latest)
- has a ready-made package per Revit year, for example
- `aec-model-bridge-revit-2026-<version>.zip`. Unzip it and run
- `.\install.ps1 -RevitVersion 2026` instead of building from source. For a double-click
- Windows installer, `scripts/build-installer.ps1` builds one with Inno Setup.
- The full guide, with troubleshooting, is in [docs/install.md](docs/install.md).
- ## Connect Claude Desktop to Revit
- Add the server to your MCP client configuration. For Claude Desktop, that is
- the `mcpServers` section of `claude_desktop_config.json`. Codex, Cursor, VS
- Code and other MCP clients use the same `command`, `args` and `env` values in
- their own config format.
- Use the Python executable from your virtual environment, and choose a workspace
- folder the server may access:
- ```json
- {
- "mcpServers": {
- "aec-model-bridge": {
- "command": "C:\\path\\to\\aec-model-bridge\\.venv\\Scripts\\python.exe",
- "args": ["-m", "revit_mcp_server.mcp_server"],
- "env": {
- "MCP_REVIT_MODE": "bridge",
- "MCP_REVIT_WORKSPACE_DIR": "C:\\RevitProjects",
- "MCP_REVIT_ALLOWED_DIRECTORIES": "C:\\RevitProjects"
- }
- },
- "aec-model-bridge-revit-2026": {
- "command": "C:\\path\\to\\aec-model-bridge\\.venv\\Scripts\\python.exe",
- "args": ["-m", "revit_mcp_server.mcp_server"],
- "env": {
- "MCP_REVIT_MODE": "bridge",
- "MCP_REVIT_HOST_VERSION": "2026",
- "MCP_REVIT_WORKSPACE_DIR": "C:\\RevitProjects",
- "MCP_REVIT_ALLOWED_DIRECTORIES": "C:\\RevitProjects"
- }
- }
- }
- }
- ```
- Leave out `MCP_REVIT_HOST_VERSION` to target the newest open Revit instance.
- Set it to a year such as `2024` or `2026` to lock a client entry to that Revit
- version. `MCP_REVIT_BRIDGE_URL` overrides the endpoint for advanced setups.
- VS Code users can start from [`.vscode/mcp.json`](.vscode/mcp.json). Hermes
- Desktop users can start from [`docs/examples/hermes-desktop.json`](docs/examples/hermes-desktop.json) after replacing the
- placeholder Python path. Clients that support MCP Bundles can install the
- `.mcpb` file from the
- [latest release](https://github.com/Sam-AEC/aec-model-bridge/releases/latest).
- The Revit add-in is still required, because the server talks to the running
- desktop application.
- ### Check the connection
- Restart Revit after installing the add-in, open a model, and run:
- ```powershell
- $registry = Get-ChildItem "$env:LOCALAPPDATA\AECModelBridge\registry\revit-*.json" | Select-Object -First 1
- $switch = Get-Content $registry.FullName -Raw | ConvertFrom-Json
- Invoke-RestMethod "$($switch.endpoint)/health"
- ```
- The response should report `healthy` and the running Revit version. In Revit,
- look for the `AEC Bridge` ribbon tab. Its Workflows panel has Open Panel,
- Health Check, Pending Actions and Reports. Its Tools panel has Config, Help
- and About.
- ## Security
- - The Revit bridge listens on localhost only.
- - The server reads and writes only inside the folders in
- `MCP_REVIT_ALLOWED_DIRECTORIES`.
- - Mutating tools need an approved plan unless you turn approval off, and
- `look_only` mode refuses them outright.
- - Approval is recorded with the channel (panel or command line) and your
- operating-system account. It does not prove who is typing, so do not give an
- AI client a shell on the account you approve plans with.
- - Tool calls are written to an audit log, and secrets are redacted.
- Details are in [docs/security.md](docs/security.md). To report a
- vulnerability, follow [SECURITY.md](SECURITY.md).
- ## FAQ
- ### What is an MCP server for Revit?
- The Model Context Protocol (MCP) is an open standard that lets AI assistants
- call tools in other software. An MCP server for Revit publishes Revit
- operations as tools. The assistant picks the tools, and the add-in runs them
- inside Revit.
- ### Which AI assistants work with it?
- Any MCP client that can start a local stdio server. Setup is documented for
- Claude Desktop, VS Code with GitHub Copilot, Cursor and Codex, and for clients
- that read a standard `mcpServers` configuration. Windsurf, Cline, Roo Code,
- Continue, Zed, Claude Code and Gemini CLI should work the same way but have not
- been tested. See [compatibility](docs/compatibility.md). The panel chat can also
- use an Anthropic API key, or the `claude` or `codex` command-line tools if they
- are installed. See [ADR 0012](docs/0012-native-agent-chat-backend.md).
- ### Can the AI change my model without asking?
- Not in the default mode. Tools that change the model are blocked until a plan
- is approved by a person, in the Revit panel or with the
- `aec-model-bridge-approve` command. Read-only tools run without approval. In
- `look_only` mode nothing that changes the model runs at all. If you set
- `MCP_REVIT_APPROVAL_MODE=auto`, approval is skipped.
- ### Does it send my model to the cloud?
- The server and the add-in run on your machine, and the bridge listens on
- localhost. The AI assistant sees what the tools return, and those results go
- to the model provider behind your client. Cloud providers, such as Speckle,
- only run when you configure them and call their tools.
- ### Does it work with IFC files without Revit?
- Yes. The IFC provider reads files with IfcOpenShell. It can return file
- metadata, the spatial structure, element properties and bounding boxes, run
- queries by class, GUID, name or property, and validate the schema. It does
- not edit IFC files.
- ### Can I use it without Revit installed?
- Only in mock mode, which is meant for development and tests. Live model work
- needs Revit 2024 to 2027 and the add-in.
- ## Releases and versions
- AEC Model Bridge follows Semantic Versioning. Releases are tagged `vX.Y.Z` on
- GitHub, and a root `VERSION` file holds the version number. See
- [docs/versioning.md](docs/versioning.md) for the release process and
- [CHANGELOG.md](CHANGELOG.md) for what changed in each version.
- ## Development
- ```powershell
- # Python tests
- python -m pytest packages/mcp-server-revit/tests
- # Build one Revit version, for example 2026
- .\scripts\build-addin.ps1 -RevitVersion 2026 -Configuration Release
- # Build all supported versions
- .\scripts\package.ps1 -RevitVersion All
- ```
- CI builds the Python server and the add-in targets for Revit 2024 through 2027.
- See [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request.
- ## Documentation
- - [Installation guide](docs/install.md)
- - [Tool reference](docs/tools-generated.md)
- - [Architecture](docs/0001-multi-provider-architecture.md)
- - [Configuration reference](docs/configuration-reference.md)
- - [Security](docs/security.md)
- - [MCP clients and registry](docs/marketplaces.md)
- - [Versioning and releases](docs/versioning.md)
- - [Release checklist](docs/release-checklist.md)
- - [First check after install](docs/first-check.md)
- - [Demo runbook](docs/demo-runbook.md)
- - [Proof bundles and revert plans](docs/proof-and-revert.md)
- - [Privacy](docs/privacy.md)
- - [Roadmap](docs/roadmap.md)
- - [All documentation](docs/README.md)
- - [Contributing](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md)
- - [Contributors](CONTRIBUTORS.md)
- ## Built with
- AEC Model Bridge stands on open-source work. It is independent and is not affiliated with or endorsed by any project named here.
- - [Model Context Protocol](https://modelcontextprotocol.io) Python SDK (MIT) for the MCP server
- - [IfcOpenShell](https://ifcopenshell.org) (LGPL-3.0-or-later) for IFC files
- - [specklepy](https://github.com/specklesystems/specklepy) (Apache-2.0) for Speckle
- - [pydantic](https://docs.pydantic.dev), [httpx](https://www.python-httpx.org), [NetworkX](https://networkx.org), [openpyxl](https://openpyxl.readthedocs.io) and [PyYAML](https://pyyaml.org) (MIT or BSD)
- - [Anthropic Python SDK](https://github.com/anthropics/anthropic-sdk-python) (MIT) for the built-in agent chat
- - [Serilog](https://serilog.net), [IronPython](https://ironpython.net) and [Microsoft WebView2](https://developer.microsoft.com/microsoft-edge/webview2/) in the Revit add-in
- - Autodesk Revit and Navisworks and McNeel Rhino are separate products that you license yourself. This project does not include their code.
- Licence texts and the full list of packages are in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md). Licences were read from package metadata; rows that could not be verified are marked as such.
- ## Project and license
- Maintained by [A. Sam Mohammad](https://github.com/Sam-AEC).
- [LinkedIn](https://www.linkedin.com/in/a-sam-mohammad-92790416b) |
- [Issues](https://github.com/Sam-AEC/aec-model-bridge/issues)
- [GPL-3.0-or-later with the Revit Linking Exception, or a commercial license](LICENSING.md).
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.