Revitmcp Revit

🚀 RevitMCP項目文檔

RevitMCP（模型上下文協議用於Revit）項目致力於為Revit軟件賦予基於MCP協議的自然語言交互能力，有效提升BIM建模與協作的效率。該項目運用領域驅動設計（DDD）、命令查詢職責分離（CQRS）模式以及分層架構，支持多目標框架，具備高可擴展性和易維護性。

🚀 快速開始

MVP演示流程

1. 用戶通過Revit的Ribbon界面啟動MCP服務。
2. 在LLM客戶端輸入自然語言指令（例如“創建一個10米×8米的房間”）。
3. 插件端發送命令，Server端解析並執行操作。
4. Server端生成模型後，將結果反饋給插件端，並展示在Revit界面中。

✨ 主要特性

• 支持自然語言查詢與建模（例如“創建一個10米×8米的房間”）
• 實現多輪對話與參數補全
• 自動生成牆體、門窗、樓板等建築模型
• 實現端到端跨進程通信與反饋
• 提供高度可擴展的DDD分層架構
• 完善的單元測試、集成測試和系統測試

📦 安裝指南

依賴說明

• 需要安裝.NET 8和.NET 9環境
• 需要Revit 2025及以上版本
• 需要MCP SDK支持

📚 詳細文檔

系統架構與設計

架構分層

• RevitMCP.Plugin（.NET 8）：Revit插件端，負責UI界面、命令發送、結果展示以及與Server的通信。
• RevitMCP.Server（.NET 9）：MCP服務器端，負責自然語言解析、命令分解、調用Revit API以及與LLM客戶端對接。
• RevitMCP.Shared（netstandard2.0）：共享層，包含DTO（數據傳輸對象）、接口和通信協議。
• docs/：詳細設計與專題文檔。

技術棧

• .NET 8（Plugin端，兼容Revit 2025）
• .NET 9（Server端，兼容MCP SDK）
• MCP官方C# SDK
• Revit API 2025
• 測試工具：xUnit、Moq、FluentAssertions
• CI/CD工具：GitHub Actions

通信機制

• Plugin與Server通過MCP協議實現跨進程通信（使用標準輸入輸出/IPC，傳輸JSON格式消息）
• Shared層定義所有跨進程消息、DTO和接口，確保各組件解耦
• Server端預留與LLM客戶端（如Claude Desktop）對接的接口

目錄結構

RevitMCP/
├── RevitMCP.Plugin/          # Revit插件代碼
├── RevitMCP.Server/         # MCP服務器代碼
├── RevitMCP.Shared/         # 共享組件（DTO、接口等）
└── docs/                    # 文檔和設計資料

開發進度與計劃

已完成

• 完成基本架構搭建
• 實現Plugin與Server的初步通信
• 支持簡單的自然語言指令解析

進行中

• 優化模型生成算法
• 增強多輪對話功能
• 擴展對更多LLM客戶端的支持

計劃中

• 提供完整的文檔支持
• 實現自動化測試流程
• 優化性能和用戶體驗

📄 許可證

本項目採用MIT License，具體條款詳見LICENSE文件。

🤝 貢獻指南

歡迎社區貢獻！請參考CONTRIBUTING.md瞭解如何參與。我們鼓勵您提交問題、修復錯誤或改進功能。