Driving Revit through MCP - revit-mcp/revit-mcp-plugin GitHub Wiki

Driving Revit through MCP

Step-by-Step Connection Guide

1. Environment Preparation

Install the following software or environments:

  • An MCP service-supported client, such as Claude, Cline, Cherry, etc.
  • Autodesk Revit 2019~2024
  • Windows 10 or Windows 11
  • .NET Framework 4.8
  • Node.js 18 or above

2. Building the MCP Server

Clone the repository

git clone https://github.com/revit-mcp/revit-mcp.git

Navigate to the project folder

cd ./revit-mcp

Install dependencies

npm install

If you encounter a "Script execution is disabled" error, first enable script execution:

Open PowerShell and enter the following command:

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

After pressing Enter, type 'Y' when prompted. Then return to the terminal and try reinstalling the dependencies.

Build the project

Enter the following command to build the project:

npm run build

Upon successful completion, a new 'build' folder will be added to the current directory. Note this folder path, for example "C:\project\revit-mcp\build", as you will need it later.

Configure the dialog client

Claude

Click: Toolbar -> File -> Settings -> Developer -> Edit Config

Claude Settings

Open the claude_desktop_config.json file, and enter the following content:

{
    "mcpServers": {
        "revit-mcp": {
            "command": "node",
            "args": ["<path to the built file>\\build\\index.js"]
        }
    }
}

Example:

Claude Config Example

Save and restart the Claude client, then check the running status:

Running Status

Cherry

// to be added

3. Installing the Revit MCP Plugin

We now provide an official installation package for the Revit MCP Plugin (v1.0.0 and above), which simplifies the setup process.

Download and Install

  1. Download the installation package from the official releases page
  2. Close Revit if it's currently running
  3. Run the installer and follow the on-screen prompts
  4. The installer will automatically register the plugin with Revit

No manual compilation or registration file creation is required when using the official installer.

Note: If you prefer to build from source or need a customized version, the source code is available in the GitHub repository.

4. Using the Plugin

  1. Start Revit
  2. The MCP plugin will be available in the "Add-Ins" tab
  3. Click on the "MCP service switch" to enable/disable the service

In your AI dialogue client, you can now enter commands to control Revit, for example: "Create a wall"

Key Features

  • Integration with MCP server, enabling AI operation of Revit
  • Support for multiple Revit versions (2019~2024)
  • Extensible command set management

Adding Custom Functionality

1. Register commands in the MCP server

// to be added

2. Add command implementation in the Revit plugin client

// to be added

Support

For questions or issues, please contact us or submit an issue through our GitHub repository.