Revit MCP

🚀 Revit MCP Server

A TypeScript-based Model Context Protocol (MCP) server for seamless integration between Claude AI and Autodesk Revit, enabling direct access to Revit models via WebSocket connections.

English | 中文

🚀 Quick Start

This TypeScript-based MCP server serves as a bridge between Claude AI and Revit, allowing real-time access to Revit model information through WebSocket connections. It implements the Model Context Protocol to achieve:

• ⚡ Real-time retrieval of Revit model information
• 🔍 Element querying and filtering
• 👀 View and floor management
• 🛡️ Robust error handling and fallback to mock data

✨ Features

🔌 Revit Integration

• 📡 Communicate with Revit plugins via WebSocket
• 🔄 Real-time access to model data
• 🔁 Automatically fallback to mock data when the connection fails
• ⚙️ Configure connection settings via environment variables

🚀 Core Functions

• 📊 Model Information

  • Retrieve basic model metadata (name, path, version)
  • Get the number of elements and the last modification date
  • Synchronize the model state in real-time

• 🏗️ Element Management

  • Query elements using flexible filters
  • Access element attributes and geometries
  • Perform batch operations on elements

• 🎪 View and Floor Control

  • List all available views
  • Get floor information
  • Traverse the model hierarchy

💻 Usage Examples

📋 Prerequisites

• Node.js (v14 or higher)
• npm
• Autodesk Revit (2023 or higher)
• Revit WebSocket plugin (companion plugin)

🔧 Installation

Install dependencies:

npm install

Build the server:

npm run build

Automatically rebuild during development:

npm run watch

⚙️ Configuration

The server can be configured via environment variables:

REVIT_HOST=127.0.0.1    # Revit plugin WebSocket server address
REVIT_PORT=8080         # Revit plugin WebSocket port

🔗 Integration with Claude Desktop

Add the server configuration to Claude Desktop:

Windows:

%APPDATA%/Claude/claude_desktop_config.json

Configuration format:

{
  "mcpServers": {
    "revit-mcp-server": {
      "command": "D:/path/to/revit-mcp-server/build/index.js"
    }
  }
}

🐛 Debugging

Debug MCP communication:

1. Use the built-in MCP inspector tool:

npm run inspector

2. Monitor the WebSocket communication with the Revit plugin
3. Check the server logs for connection and operation status information

⚠️ Error Handling

The server implements a robust error handling mechanism:

• Automatically fallback to mock data when the connection to Revit fails
• Detailed error logging
• Smooth connection recovery

📄 License

MIT License

🤝 Contribution

Contributions are welcome! Please feel free to submit pull requests.

📬 Contact

If you have any questions or suggestions, please feel free to contact us:

• 📧 Email: 353554036@qq.com
• 💬 WeChat: modian4500