Revit API MCP

Revit API MCP 服务

概述

Revit API 的范围大得惊人，因此 AI 经常会虚构类、方法、属性，甚至整个命名空间。此外，一些实用但非官方或不常见的 API 用法非常冷门，AI 对此一无所知。为解决这个问题，这个 MCP 服务让大模型能够访问 Revit API 文档及其他相关内容（参见 Rvt_Docs_Tbc_Embedder）。在底层，它同时使用 rvtdocs.com 和 revitapidocs.com；如果启用，还会使用 Building Coder Blog。

只需询问 MCP 客户端 Revit API 文档对某个问题有何说明，它就会组合使用各种工具，自行探索 API 文档。

功能

• 搜索 Revit API：在 Revit API 文档中搜索类、方法和属性（或任何 API 实体）。
• 访问文档：通过 URL 或实体名称获取 API 实体文档页面的内容。
• 搜索/访问 TBC Blog：对 The Building Coder 博客嵌入内容的向量空间执行语义搜索。

功能（计划中）

• 代码示例：获取 Revit API 用法的代码示例并使其可供访问。参见 RevitSdkSamples。也可能包括完整的代码库，例如 ricuan-io、Nice3point、chuongmep、kilkelly 的代码库，当然还有 jeremytammik 的代码库。
• 更多资源：向向量存储添加其他内容。候选内容包括与 TBC 相关的 PDF、零散的博客文章和 Autodesk University 资源。
• 缓存（不太可能）：缓存响应，减少对 API 文档网站的访问。

工具

此代码库提供四个用于处理 Revit API 文档的 MCP 工具：

• search-docs - 搜索 Revit API 文档，查找与查询相匹配的实体。返回实体名称、说明、命名空间、类型和 URL slug，供进一步探索（但不返回文档本身）。

• retrieve-doc - 使用 URL slug 获取单个 Revit API 文档页面。在搜索操作获得 URL slug 后使用。

• retrieve-docs - 根据搜索查询，获取多个 Revit API 实体的完整文档内容。适用于需要完整文档内容，而不只是搜索结果的情况。

• search-library - 搜索全面的 Revit API 学习资源库，包括博客文章、代码示例、PDF 和实践指南。由 OpenAI 的向量存储提供语义搜索支持。

设置

从 Releases 下载适用于你操作系统的可执行文件。或者，你可以克隆代码库并使用 deno task compile 从源代码构建。将此可执行文件放到文件系统中合适的位置。对于 Windows，建议放在 <username>/bin/，但也可以放在任何位置。

在终端中运行 path\to\executable -h，查看帮助菜单。供你参考：除了查看帮助菜单和测试即将添加到 MCP 配置中的命令外，在终端运行此可执行文件没有其他用途。

精简版帮助菜单

要使用 MCP 服务，请将可执行文件添加到你所用 MCP 客户端和操作系统对应的 MCP 配置中。

{
  "mcpServers": {
    "revit-api-docs (macos-arm64)": {
      "command": "path/to/Rvt_Docs_MCP-macos-arm64"
    },
    "revit-api-docs (macos-x64)": {
      "command": "path/to/Rvt_Docs_MCP-macos-x64"
    },
    "revit-api-docs (windows)": {
      "command": "path\\to\\Rvt_Docs_MCP-windows.exe"
    },
    "revit-api-docs (with search-library enabled)": {
      "command": "path\\to\\Rvt_Docs_MCP-windows.exe",
      "args": ["-v", "vs_xxx", "-k", "sk-proj-xxx"]

    }
  }
}

要启用 search-library，必须先按照 Rvt_Docs_Tbc_Embedder 中的步骤操作。完成后，按上文所示，使用 -k（OpenAI API 密钥）和 -v（OpenAI 向量存储 ID）标志运行可执行文件。要验证运行是否正常，请在终端中单独运行该命令。输出内容有参考价值，但如上所述，除此之外没有实际用途。

开发与贡献

本项目完全开放，欢迎贡献。坦白说，我之前从未发布过供他人使用的代码，所以不太了解许可证和拉取请求的运作方式，还请多多包涵。任何方面的帮助都非常欢迎。

关于许可的另一点说明。我使用了 rvtdocs.com 和 revitapidocs.com 的搜索 API（这些 API 是我从网络控制台中提取的）。我对此是否合法感到担忧，但找不到相关许可证。我无意做任何不当的事，如果这有问题，请告诉我。

本项目使用 Deno 作为运行时。你可以直接运行 deno task dev 来启动 MCP 服务。我设置了这个命令，使其在 localhost 上运行 MCP inspector，并通过 HMR 监听代码库。由于 inspector 会运行它，HMR 会稍慢一些，请留意这一点。

源代码应该很容易理解，也欢迎添加任何新工具。我唯一的要求是，如果工具需要进一步设置，你必须提供简单易用的流程来让它能够正常使用（例如 Rvt_Docs_Tbc_Embedder）。

我们已在 GitHub 工作流中使用 Deno 配置了简单的跨平台编译。要触发构建，请创建一个新的 git 标签，然后运行 git push --follow-tags 推送。