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了解如何参与。我们鼓励您提交问题、修复错误或改进功能。