
kaitpw/rvt_docs_mcp
Developer toolsЭта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал
An MCP server that exposes the Revit API docs and sample code to LLMs.
Обзор
Because of the absurd surface area of the Revit API, AI often hallucinates classes, methods, properties, or even entire namespaces. Furthermore, useful, but unofficial or uncommon uses of the API are so niche that AI's have no knowledge of it. To curb this, this MCP server provides LLMs access to Revit API documentation and other related content (see Rvt_Docs_Tbc_Embedder). Under the hood, it uses both rvtdocs.com and revitapidocs.com, and if enabled, the Building Coder Blog. Simply ask your MCP client what the Revit API docs say about something and it will use a combination of tools to explore the API docs on its own. - : Search for classes, methods, and properties (or any API entity) in the Revit API documentation. - : Retrieve the content of an API entity's docs page either via the url or the entities name. - : Perform semantic search over a vector space of The Building Coder blog embeddings. - : Get code examples for Revit API usage and make them accessible.
README
Показан фрагмент оригинального README. Открыть оригинал.
Revit API MCP Server
Overview
Because of the absurd surface area of the Revit API, AI often hallucinates classes, methods, properties, or even entire namespaces. Furthermore, useful, but unofficial or uncommon uses of the API are so niche that AI’s have no knowledge of it. To curb this, this MCP server provides LLMs access to Revit API documentation and other related content (see Rvt_Docs_Tbc_Embedder). Under the hood, it uses both rvtdocs.com and revitapidocs.com, and if enabled, the Building Coder Blog.
Simply ask your MCP client what the Revit API docs say about something and it will use a combination of tools to explore the API docs on its own.
Features
- Search Revit API: Search for classes, methods, and properties (or any API entity) in the Revit API documentation.
- Access Documentation: Retrieve the content of an API entity’s docs page either via the url or the entities name.
- Search/Access TBC Blog: Perform semantic search over a vector space of The Building Coder blog embeddings.
Features (Planned)
- Code Examples: Get code examples for Revit API usage and make them accessible. See RevitSdkSamples. Or maybe even entire repos, like those from ricuan-io, Nice3point, chuongmep, kilkellym, and of course jeremytammik.
- More Resources: Add other content to the vector store. Candidates include tbc-related pdfs, random blog posts, and Autodesk University resources.
- Caching (Unlikely): Cache responses to reduce traffic to the api doc sites.
Tools
This repository provides four MCP tools for working with Revit API documentation:
-
search-docs- Search Revit API documentation to find entities matching your query. Returns entity names, descriptions, namespaces, types, and URL slugs for further exploration (but not the documentation itself). -
retrieve-doc- Retrieve a single Revit API documentation page using its URL slug. Use this after getting a URL slug from a search operation. -
retrieve-docs- Get full documentation content for multiple Revit API entities based on a search query. Useful when you need complete documentation content, not just search results. -
search-library- Search a comprehensive library of Revit API learning resources including blog posts, code examples, PDFs, and practical guides. Powered by OpenAI’s vector store for semantic search.
Setup
Download the executable for your OS from
Releases. Or you can clone
and build from source using deno task compile. Add this executable somewhere
in your file system that makes sense. Good practice for Windows is
/bin/, but it can be anywhere.
Run path\to\executable -h in your terminal to see the help menu. FYI: This
executable is useless to run in the terminal besides for the help menu and for
Установка
This server does not publish a one-line install command.
Open the repository installation guide Новичок в MCP? Начните с руководства на mcpskill.org →Конфигурация
{
"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"]
}
}
}