Skip to content

Open-source Revit MCP server: let Claude and other AI assistants read and edit BIM models, with human approval on every change.

4.5 KB
Raw Blame

Documentation index

Status: on the dev branch, not yet released.

Start with the installation guide. The main README covers what the project is and how to connect a client.

Guides and reference

  • install.md: install the Revit add-in and the MCP server.
  • first-check.md: from install to ready, using the panel's Setup check card.
  • VS Code extension: build and install the extension locally.
  • configuration-reference.md: environment variables, package metadata and runtime settings.
  • tools-generated.md: the tool catalog, generated from the server (do not edit by hand).
  • rule-packs.md: write, validate, import and share QA/QC rule packs.
  • security.md: trust boundaries, workspace sandboxing and enterprise hardening.
  • logging-and-audit.md: Python-side audit log and add-in logging.
  • marketplaces.md: MCP Registry, Claude Code plugin, extension stores and client distribution.
  • privacy.md: what stays on your computer, what leaves it, and how to delete it (draft, awaiting owner sign-off).
  • Client setup guides (snippets not yet tested on live installs): Visual Studio, JetBrains, Codex, Gemini CLI, Windsurf, Cline.
  • versioning.md: version numbers, release tags and release assets.
  • clash-triage.md: read-only matching of Navisworks clashes to Revit elements, with a confidence label (unverified on live projects).
  • roadmap.md: coordinator workflows, demo scope and the next fixes.
  • demo-runbook.md: step-by-step script for the missing-door-Mark demo, with expected counts and a rejected-plan run.

For contributors

Architecture decision records

  • 0001: multi-provider automation architecture.
  • 0002: switch contract v2.
  • 0007: hub performance posture.
  • 0008: approval gate and action plan lifecycle.
  • 0009: plugin module system.
  • 0010: semantic BIM snapshot and delta schema.
  • 0011: WebView2 dockable panel and hub message bridge.
  • 0012: native tool-calling loop for chat.
  • 0013: proposal for running Dynamo, pyRevit and Python automation behind the approval gate.
  • 0014: proposal for routing to the right Revit when several are open.
  • 0015: proposal (scoping only) for the Navisworks clash to Revit fix loop, and BCF.
  • 0016: Proposed, not built. Cerberus, a multi-head read-only model review with cross-checking and one approved plan.
  • 0017: proposal to bind approvals to a Revit document and expire them.

Numbers 0003 to 0006 are not in this repository.

Diagrams

  • diagrams/: Mermaid sources for the architecture and approval-flow diagrams in the README. images/ holds the rendered light and dark PNGs; regenerate them with scripts/render_diagrams.py.