============================================================
  Soar Revit MCP — V1.1.1
  One-click installer (Customer Edition for Claude / Cowork)
  For Autodesk Revit 2024
  By Soar Design (Jimmy Kwok) © 2026
============================================================

[ BEFORE YOU INSTALL ]

1. Windows 10 / 11, 64-bit
2. Autodesk Revit 2024 installed (currently 2024 only;
   2025 / 2026 support coming later)
3. Claude Desktop or Cowork already installed
4. A Soar Design Revit license key
       Format: SOAR-XXXX-XXXX-XXXX-XXXX
       (Revit and Office licenses are independent — they don't share keys)

* No Python required! The installer includes all executables.

[ ARCHITECTURE OVERVIEW ]

Soar Revit MCP has two parts:

  (a) C# Revit Addin (RevitMCPBridge.dll)
      - Runs inside Revit, listens on a Named Pipe, calls the Revit API directly
      - Auto-installed to %APPDATA%\Autodesk\Revit\Addins\2024\

  (b) MCP Server (launcher.exe + in-memory server)
      - Runs as the stdio subprocess that Claude / Cowork spawns
      - On every launch, checks Cloudflare for a newer server module
      - The C# Addin DLL is NOT auto-updated (re-run the installer to update it)

[ INSTALL STEPS ]

1. Unzip this package to any folder (recommended: D:\SoarMCP\Revit)
   * Avoid Program Files (permission issues)
   * Avoid paths containing Chinese characters, spaces, parentheses,
     or special characters

2. Double-click install.bat
   Wait for the script to finish all 5 steps:
   - Check launcher.exe exists
   - Prompt for your license key
   - Auto-copy RevitMCPBridge.dll + .addin to
     %APPDATA%\Autodesk\Revit\Addins\2024\
   - Test connection to Cloudflare and pull the latest server module
   - Write the Cowork MCP config

3. When you see "Installation complete!":
   a. If Revit is already running, close and reopen Revit 2024
   b. Open any .rvt file
   c. Quit Cowork / Claude Desktop completely and reopen
   d. Test prompt: "ping Revit" or "List all walls"

[ DAILY USE ]

* Open Autodesk Revit 2024 + an .rvt file (not the Start page)
* Open Claude / Cowork
* Ask Claude in plain language, for example:
    "List all walls"
    "Build a 3-story building, 3m floor-to-floor, 5x6m footprint"
    "Move grid A 2m to the right"
    "Export the current view as PDF"
    "Run Dynamo script 'BatchRename.dyn'"

The MCP routes commands to the Revit MCP Bridge and drives Revit directly.

[ AUTO-UPDATE ]

The server logic auto-updates: each time the MCP starts, the launcher
checks Cloudflare for a newer server module and downloads it into RAM.
You don't have to do anything.

NOTE: The C# Addin DLL does NOT auto-update. Re-run install.bat to update it
      (Revit must be closed before the DLL can be replaced).

[ UNINSTALL ]

Double-click uninstall.bat. It removes:
* The local cache
* The "soar-revit" entry inside the Cowork / Claude config
* The 3 addin files inside %APPDATA%\Autodesk\Revit\Addins\2024\
  (close Revit before running uninstall.bat, otherwise the files
   will be locked)

[ EMERGENCY UNLOCK ]

If the MCP is locked (e.g. anomaly triggered), double-click unlock_mcp.bat
to clear local lock files, then restart the MCP.

[ TROUBLESHOOTING ]

Q: install.bat says "Install path contains special characters".
A: The path has parentheses, !, & or similar. Move to a simple path
   like D:\SoarMCP\Revit

Q: install.bat says "Autodesk Revit not found".
A: Revit isn't installed, or it's installed in a non-default location.
   Confirm Revit 2024 is installed.

Q: Revit opens but the addin doesn't load.
A: Check Revit's Add-Ins panel and confirm "RevitMCPBridge" is enabled.
   Or check %APPDATA%\Autodesk\Revit\Addins\2024\ for these 3 files:
       RevitMCPBridge.addin
       RevitMCPBridge.dll
       Newtonsoft.Json.dll

Q: Claude / Cowork doesn't see the Revit MCP.
A: Check that:
   1. install.bat finished without errors
   2. You quit Cowork completely (File -> Exit, not the X)
   3. If the problem persists, contact Soar

Q: MCP connects but Revit API commands report "no Revit detected".
A: Revit must be running and have at least one project (.rvt) open.

Q: License says invalid.
A: Double-check the key. If expired, contact Soar.
   Note: Revit keys are separate from Office keys.

Q: License says "bound to another machine".
A: Each license is bound to one machine. Contact Soar for a transfer.

[ SUPPORT ]

Email   : info@soarmcpsoftware.com
Subject : Please include the first 8 chars of your license key
          (e.g. SOAR-AB12 Revit issue)

============================================================
