revit-api-docs 0.1.0__tar.gz

revit_api_docs-0.1.0/.gitignore

@@ -0,0 +1,21 @@
+# Secrets never enter this repository
+.env*
+!.env.example
+.secrets/
+*.token
+
+# Python
+__pycache__/
+*.pyc
+.venv/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+
+# Local data set copies and pipeline output (the data set ships as a GitHub Release)
+data/
+out/
+
+# Local Claude Code state
+.claude/settings.local.json

revit_api_docs-0.1.0/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versions follow
+[Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-09-20
+
+First release, split out of the `revit-api-rag` repository (working-tree copy,
+no git history).
+
+### Added
+
+- MCP server `revit-api-docs` (stdio) with two read-only tools:
+  `search_revit_api(query, top_k)` and `get_code_examples(query, top_k)`.
+- Data set as GitHub Release `v1.0-data` (Revit 2026 API reference SQLite,
+  SDK samples SQLite, two ChromaDB indexes); downloaded on first run into the
+  per-user data directory, SHA-256 verified, resumable. `REVIT_API_DOCS_DATA_DIR`
+  overrides the location; `revit-api-docs download` prefetches.
+- Keyword search over SQLite works with no API key; an OpenAI-compatible
+  embedding key adds vector search, `COHERE_API_KEY` adds reranking. Embedding
+  or rerank failures fall back to keyword search instead of erroring.
+- CLI: `serve` (default), `download`, `search <query> [--examples] [--top-k]`.
+- Offline data pipeline (`pipeline/`, `uv sync --extra pipeline`) from the old
+  repository, importing the package's shared retriever, LLM client and prompts.
+- CI (tests + build on Linux/Windows, Python 3.11/3.13) and PyPI Trusted
+  Publishing on version tags.
+
+[Unreleased]: https://github.com/revitbridge/revit-api-docs/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/revitbridge/revit-api-docs/releases/tag/v0.1.0

revit_api_docs-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 revitbridge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

revit_api_docs-0.1.0/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.5
+Name: revit-api-docs
+Version: 0.1.0
+Summary: Revit API reference search for MCP hosts: local semantic + keyword lookup over the Revit 2026 API docs and SDK samples
+Project-URL: Homepage, https://github.com/revitbridge/revit-api-docs
+Project-URL: Issues, https://github.com/revitbridge/revit-api-docs/issues
+Project-URL: Changelog, https://github.com/revitbridge/revit-api-docs/blob/main/CHANGELOG.md
+Project-URL: Data, https://github.com/revitbridge/revit-api-docs/releases/tag/v1.0-data
+Author: revitbridge
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api-docs,bim,mcp,rag,revit
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Requires-Dist: chromadb<2,>=1
+Requires-Dist: httpx>=0.27
+Requires-Dist: mcp<3,>=2
+Requires-Dist: openai<3,>=1
+Requires-Dist: pyyaml>=6
+Provides-Extra: pipeline
+Requires-Dist: beautifulsoup4>=4.12; extra == 'pipeline'
+Requires-Dist: google-genai>=1; extra == 'pipeline'
+Requires-Dist: tqdm>=4.66; extra == 'pipeline'
+Requires-Dist: tree-sitter-c-sharp>=0.20; extra == 'pipeline'
+Requires-Dist: tree-sitter>=0.20; extra == 'pipeline'
+Description-Content-Type: text/markdown
+
+# revit-api-docs
+
+Revit API reference search as an MCP server: two read-only tools over a local
+copy of the Revit 2026 API documentation (27,596 classes, methods, properties
+and enums) and the official SDK samples (153 projects).
+
+**Optional.** It exists for models that do not know the Revit API well. If
+your model already writes correct Revit code, you do not need it;
+[revit-bridge](https://github.com/revitbridge/revit-bridge) works without it.
+It never talks to Revit and it never calls a model itself.
+
+## Install
+
+Prerequisites: Python 3.11+ with [`uv`](https://docs.astral.sh/uv/) (for
+`uvx`), about 700 MB of disk for the data set, network for the first run.
+
+**Claude Desktop** — `claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "revit-api-docs": {
+      "command": "uvx",
+      "args": ["revit-api-docs"]
+    }
+  }
+}
+```
+
+**Claude Code**:
+
+```bash
+claude mcp add revit-api-docs -- uvx revit-api-docs
+```
+
+**Any MCP client** — run `uvx revit-api-docs` as a stdio server.
+
+On the first start the server downloads the data set (335 MB, four files) from
+this repository's [`v1.0-data` release](https://github.com/revitbridge/revit-api-docs/releases/tag/v1.0-data)
+into `%LOCALAPPDATA%\revit-api-docs` (Windows) or `~/.local/share/revit-api-docs`
+(Linux; `~/Library/Application Support/revit-api-docs` on macOS), verifies each
+file's SHA-256 and unpacks the vector stores. Tool calls made while that runs
+return a short progress message instead of results. To do it ahead of time:
+
+```bash
+uvx revit-api-docs download
+```
+
+From a checkout: `uv sync` then `uv run revit-api-docs`.
+
+## Use
+
+Two tools, both read-only:
+
+- `search_revit_api(query, top_k=10)` — API entries with signature, parameters
+  and remarks. Query with an API name (`Wall.Create`,
+  `FilteredElementCollector OfCategory`) or a short task (`create floor from
+  boundary`).
+- `get_code_examples(query, top_k=3)` — C# from the SDK samples that use the
+  matching APIs, with the project name and the APIs each sample touches.
+
+Without any API key the server answers from keyword search over the SQLite
+reference (exact and partial name matches, which is what a model usually
+asks for once it knows roughly what it wants). With an embedding key it adds
+semantic search over the vector store, and with a Cohere key it reranks the
+merged candidates. See Configure.
+
+Try it from a terminal (installs the data set if needed):
+
+```bash
+uvx revit-api-docs search "Wall.Create"
+uvx revit-api-docs search "rotate element around axis" --examples
+```
+
+## Configure
+
+All settings are environment variables; there is no config file to edit.
+
+| Variable | Default | Meaning |
+|---|---|---|
+| `REVIT_API_DOCS_DATA_DIR` | `%LOCALAPPDATA%\revit-api-docs` (Windows), `~/.local/share/revit-api-docs` (Linux), `~/Library/Application Support/revit-api-docs` (macOS) | Where the data set lives. An existing tree with `sqlite/` and `chromadb/` from the old `revit-api-rag` checkout works as is |
+| `REVIT_API_DOCS_EMBEDDING_API_KEY` | *(unset)* | Key for the embedding endpoint; turns on semantic (vector) search. `OPENROUTER_API_KEY` is used when this is unset |
+| `REVIT_API_DOCS_EMBEDDING_BASE_URL` | `https://openrouter.ai/api/v1` | Any OpenAI-compatible `/embeddings` endpoint |
+| `REVIT_API_DOCS_EMBEDDING_MODEL` | `openai/text-embedding-3-large` | Must produce the same 3072-dimensional space the shipped vectors were built with (`text-embedding-3-large`); another model makes vector search return noise |
+| `COHERE_API_KEY` | *(unset)* | Enables reranking with Cohere `rerank-v3.5` (native REST API) |
+| `REVIT_API_DOCS_RELEASE_URL` | this repository's `v1.0-data` release | Mirror for the data files; the SHA-256 checks still apply |
+| `HTTPS_PROXY` / `HTTP_PROXY` | *(unset)* | Proxy for the embedding and rerank calls |
+
+Pass them through the `env` block of your MCP host's server entry.
+
+Data set: the SQLite databases and ChromaDB indexes were built from the Revit
+2026 API CHM and the Revit 2026 SDK samples with the pipeline in `pipeline/`
+(`uv sync --extra pipeline`; needs the CHM, the SDK and OpenRouter/Cohere keys
+in the environment). The server does not need any of that.
+
+Development:
+
+```bash
+uv sync
+uv run pytest
+uv build
+uvx --from . revit-api-docs search "Wall.Create"
+```
+
+License: MIT. Issues and discussion: <https://github.com/revitbridge/revit-api-docs/issues>.

revit_api_docs-0.1.0/README.md

@@ -0,0 +1,105 @@
+# revit-api-docs
+
+Revit API reference search as an MCP server: two read-only tools over a local
+copy of the Revit 2026 API documentation (27,596 classes, methods, properties
+and enums) and the official SDK samples (153 projects).
+
+**Optional.** It exists for models that do not know the Revit API well. If
+your model already writes correct Revit code, you do not need it;
+[revit-bridge](https://github.com/revitbridge/revit-bridge) works without it.
+It never talks to Revit and it never calls a model itself.
+
+## Install
+
+Prerequisites: Python 3.11+ with [`uv`](https://docs.astral.sh/uv/) (for
+`uvx`), about 700 MB of disk for the data set, network for the first run.
+
+**Claude Desktop** — `claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "revit-api-docs": {
+      "command": "uvx",
+      "args": ["revit-api-docs"]
+    }
+  }
+}
+```
+
+**Claude Code**:
+
+```bash
+claude mcp add revit-api-docs -- uvx revit-api-docs
+```
+
+**Any MCP client** — run `uvx revit-api-docs` as a stdio server.
+
+On the first start the server downloads the data set (335 MB, four files) from
+this repository's [`v1.0-data` release](https://github.com/revitbridge/revit-api-docs/releases/tag/v1.0-data)
+into `%LOCALAPPDATA%\revit-api-docs` (Windows) or `~/.local/share/revit-api-docs`
+(Linux; `~/Library/Application Support/revit-api-docs` on macOS), verifies each
+file's SHA-256 and unpacks the vector stores. Tool calls made while that runs
+return a short progress message instead of results. To do it ahead of time:
+
+```bash
+uvx revit-api-docs download
+```
+
+From a checkout: `uv sync` then `uv run revit-api-docs`.
+
+## Use
+
+Two tools, both read-only:
+
+- `search_revit_api(query, top_k=10)` — API entries with signature, parameters
+  and remarks. Query with an API name (`Wall.Create`,
+  `FilteredElementCollector OfCategory`) or a short task (`create floor from
+  boundary`).
+- `get_code_examples(query, top_k=3)` — C# from the SDK samples that use the
+  matching APIs, with the project name and the APIs each sample touches.
+
+Without any API key the server answers from keyword search over the SQLite
+reference (exact and partial name matches, which is what a model usually
+asks for once it knows roughly what it wants). With an embedding key it adds
+semantic search over the vector store, and with a Cohere key it reranks the
+merged candidates. See Configure.
+
+Try it from a terminal (installs the data set if needed):
+
+```bash
+uvx revit-api-docs search "Wall.Create"
+uvx revit-api-docs search "rotate element around axis" --examples
+```
+
+## Configure
+
+All settings are environment variables; there is no config file to edit.
+
+| Variable | Default | Meaning |
+|---|---|---|
+| `REVIT_API_DOCS_DATA_DIR` | `%LOCALAPPDATA%\revit-api-docs` (Windows), `~/.local/share/revit-api-docs` (Linux), `~/Library/Application Support/revit-api-docs` (macOS) | Where the data set lives. An existing tree with `sqlite/` and `chromadb/` from the old `revit-api-rag` checkout works as is |
+| `REVIT_API_DOCS_EMBEDDING_API_KEY` | *(unset)* | Key for the embedding endpoint; turns on semantic (vector) search. `OPENROUTER_API_KEY` is used when this is unset |
+| `REVIT_API_DOCS_EMBEDDING_BASE_URL` | `https://openrouter.ai/api/v1` | Any OpenAI-compatible `/embeddings` endpoint |
+| `REVIT_API_DOCS_EMBEDDING_MODEL` | `openai/text-embedding-3-large` | Must produce the same 3072-dimensional space the shipped vectors were built with (`text-embedding-3-large`); another model makes vector search return noise |
+| `COHERE_API_KEY` | *(unset)* | Enables reranking with Cohere `rerank-v3.5` (native REST API) |
+| `REVIT_API_DOCS_RELEASE_URL` | this repository's `v1.0-data` release | Mirror for the data files; the SHA-256 checks still apply |
+| `HTTPS_PROXY` / `HTTP_PROXY` | *(unset)* | Proxy for the embedding and rerank calls |
+
+Pass them through the `env` block of your MCP host's server entry.
+
+Data set: the SQLite databases and ChromaDB indexes were built from the Revit
+2026 API CHM and the Revit 2026 SDK samples with the pipeline in `pipeline/`
+(`uv sync --extra pipeline`; needs the CHM, the SDK and OpenRouter/Cohere keys
+in the environment). The server does not need any of that.
+
+Development:
+
+```bash
+uv sync
+uv run pytest
+uv build
+uvx --from . revit-api-docs search "Wall.Create"
+```
+
+License: MIT. Issues and discussion: <https://github.com/revitbridge/revit-api-docs/issues>.