Revitmcp Revit

🚀 RevitMCP Project Documentation

RevitMCP (Model Context Protocol for Revit) aims to introduce natural language interaction capabilities based on the MCP protocol to Revit, thereby significantly enhancing the efficiency of BIM modeling and collaboration. This project adopts Domain-Driven Design (DDD), Command Query Responsibility Segregation (CQRS) patterns, and a layered architecture, and supports multi-target frameworks. It features high scalability and ease of maintenance.

🚀 Quick Start

The RevitMCP project is designed to enhance the BIM modeling and collaboration experience in Revit through natural language interaction. To get started, ensure you have the necessary dependencies installed and follow the MVP demo process to see the system in action.

✨ Features

• Support natural language queries and modeling (e.g., "Create a room that is 10 meters by 8 meters").
• Implement multi-round conversations and parameter completion.
• Automatically generate building models such as walls, doors, windows, and floors.
• Achieve end-to-end cross-process communication and feedback.
• Provide a highly scalable DDD layered architecture.
• Offer comprehensive unit, integration, and system testing.

📦 Installation

• Install the .NET 8 and .NET 9 environments.
• Ensure you have Revit 2025 or a later version.
• Obtain support from the MCP SDK.

💻 Usage Examples

Basic Usage

1. Launch the MCP service through the Revit Ribbon interface.
2. Enter natural language instructions in the LLM client (e.g., "Create a room that is 10 meters by 8 meters").
3. The plugin sends the command, and the server parses and executes the operation.
4. After the server generates the model, it feeds the results back to the plugin and displays them in the Revit interface.

📚 Documentation

System Architecture and Design

Architecture Layers

• RevitMCP.Plugin (.NET 8): The Revit plugin side is responsible for the UI, command sending, result display, and communication with the server.
• RevitMCP.Server (.NET 9): The MCP server side handles natural language parsing, command decomposition, calls to the Revit API, and docking with LLM clients.
• RevitMCP.Shared (netstandard2.0): The shared layer contains DTOs (Data Transfer Objects), interfaces, and communication protocols.
• docs/: Detailed design and thematic documents.

Technology Stack

• .NET 8 (Plugin side, compatible with Revit 2025)
• .NET 9 (Server side, compatible with the MCP SDK)
• MCP official C# SDK
• Revit API 2025
• Testing tools: xUnit, Moq, FluentAssertions
• CI/CD tools: GitHub Actions

Communication Mechanism

• The plugin and the server achieve cross-process communication through the MCP protocol (using standard input/output/IPC to transmit JSON messages).
• The shared layer defines all cross-process messages, DTOs, and interfaces to ensure component decoupling.
• The server side reserves an interface for docking with LLM clients (e.g., Claude Desktop).

Development Progress and Plan

Completed

• Completed the basic architecture setup.
• Achieved initial communication between the plugin and the server.
• Supported simple natural language instruction parsing.

In Progress

• Optimizing the model generation algorithm.
• Enhancing the multi-round conversation function.
• Expanding support for more LLM clients.

Planned

• Provide comprehensive documentation support.
• Implement an automated testing process.
• Optimize performance and the user experience.

Directory Structure

RevitMCP/
├── RevitMCP.Plugin/          # Revit plugin code
├── RevitMCP.Server/         # MCP server code
├── RevitMCP.Shared/         # Shared components (DTOs, interfaces, etc.)
└── docs/                    # Documentation and design materials

Dependency Instructions

• Requires the installation of .NET 8 and .NET 9 environments.
• Requires Revit 2025 or a later version.
• Requires MCP SDK support.

Contribution Guidelines

Community contributions are welcome! Please refer to CONTRIBUTING.md to learn how to get involved. We encourage you to submit issues, fix bugs, or improve features.

📄 License

This project is licensed under the MIT License. For specific terms, please refer to the LICENSE file.