revit MCP dotnet template

Revit MCP DotNet项目

语言： 中文 |英语

此项目包含两个主要组件：Revit MCP（MCP）服务器和与其通信的Revit插件。

Revit MCP项目

Revit MCP项目(NET.Mcp.Server)是a。NET Core应用程序，充当主应用程序和Revit应用程序之间的桥梁。它在Revit环境中监听命令并执行命令。

配置

MCP服务器通过以下方式配置 mcpConfig.json 文件位于 src\NET.App.Revit\NET.Mcp.Server\此文件定义了如何启动MCP服务器进程。

例如，要为配置它 trae 在环境中，您可以将项目路径设置为本地计算机的路径。

示例 mcpConfig.json:

{
  "mcpServers": {
    "revit": {
      "command": "dotnet",
      "args": [
        "run",
        "--project",
        "d\\yourpath\\revit_mcp_dotnet_template\\src\\NET.App.Revit\\NET.Mcp.Server",
        "--no-build"
      ],
      "env": {}
    }
  }
}

注： 确保 --project 路径指向正确的位置 NET.Mcp.Server 在您的机器上进行项目。

运行服务器

要运行MCP服务器，您可以执行在 mcpConfig.json 从您的终端。基于上述示例，您可以运行：

dotnet run --project d:\GitHub\revit_mcp_dotnet-main\src\NET.App.Revit\NET.Mcp.Server

这将启动服务器，然后等待Revit插件连接。

Revit插件项目

Revit插件(NET.App.Revit)是Autodesk Revit的附加模块，连接到MCP服务器并允许对Revit进行外部控制。

Revit中的用法

1. 构建项目：构建 NET.App.Revit.sln 生成插件DLL的解决方案。
2. 在Revit中加载插件:

- 复制生成的 .addin 将文件和相关DLL添加到Revit Add-ins文件夹（例如。， %APPDATA%\Autodesk\Revit\Addins\2022). - 启动Autodesk Revit。

1. 运行插件:

- 加载后，您将在Revit的“附加模块”选项卡中找到新命令。 - 使用“启动服务器”命令（或类似命令）启动与正在运行的MCP服务器的连接。

版本兼容性

此插件当前已配置和测试 2022年修订版.

如果需要将其与其他版本的Revit（例如2021、2023、2024）一起使用，则需要：

1. 更新中的Revit API参考 .csproj 文件。
2. 调整 .addin 文件以定位所需的Revit版本。
3. 重建项目。

示例包括

• MCP服务器（.NET）：位于 src/NET.App.Revit/NET.Mcp.Server。包括一个样本 mcpConfig.json （以Trae为例）在本地启动服务器。
• Revit插件（.NET）：位于 src/NET.App.Revit/NET.App.Revit。包含附加模块项目和在Revit中加载它的说明。

这两个示例都在上实现。NET端。该插件已通过Revit 2022验证；其他版本需要手动配置API引用和 .addin 目标。

快速链接

• 详细的Revit应用程序指南（英文）： src/NET.App.Revit/README.md
• 详细中文指南：src/NET.App.Revit/README.zh-CN.md

Trae MCP配置

下面是在Trae中粘贴MCP配置JSON的位置。添加后切换服务器。

Trae MCP Config Dialog

如何使用 mcpConfig.json 在Trae

• 打开Trae，前往 MCP 选项卡。
• 点击 + Add → 选择 Manual Config (JSON).
• 将JSON从您的 mcpConfig.json （见上例）。
• 点击 Confirm 并确保新服务器出现在列表中。
• 打开服务器以启动它。

启动项目（逐步）

• 先决条件：安装 '.NET 8 SDK' 和 Revit 2022 （其他版本需要手动插件配置）。
• 构建插件：打开 src/NET.App.Revit/NET.App.Revit.sln，构建发布，复制 .addin 以及DLL %APPDATA%\Autodesk\Revit\Addins\2022.
• 启动MCP服务器（CLI）：运行 dotnet run --project d:\GitHub\revit_mcp_dotnet-main\src\NET.App.Revit\NET.Mcp.Server.
• 启动MCP服务器（Trae）：通过MCP选项卡添加JSON（如上所述）并打开。
• 启动Revit：打开Revit，插件出现在 Add-ins。使用该命令连接到正在运行的MCP服务器。
• 验证：通过MCP客户端执行一个简单的命令或观察日志，以确认Revit会话受到控制。