pi-revit 0.2.15 → 0.2.17

package/CHANGELOG.md

@@ -7,6 +7,39 @@ Format follows [Keep a Changelog](https://keepachangelog.com/); version headers
 Every published version gets an entry with **Added** / **Changed** / **Fixed** sections
 describing what the user will notice — not internal refactors.
 
+## [0.2.17] - 2026-08-21
+
+### Fixed
+- The bridge's no-document check no longer counts linked documents. With only links
+  loaded, Revit does not pump the bridge's work queue, so a call could wait out its full
+  timeout instead of failing immediately with the clean "no active document" answer.
+
+### Changed
+- Docs and tool descriptions describe localized parameter names generically instead of
+  quoting specific languages.
+- The full search_api_docs benchmark (641 live queries against RevitAPI.xml ground truth)
+  was re-run on Revit 2025 at 0.2.16: 100% recall, 98.75% top-1 on exact names, 100%
+  spacing-variant agreement, 0 false positives across 99 adversarial mutations, 50/50
+  parameter docs, p50 10 ms -- no regression across the 0.2.13-0.2.16 search changes.
+
+Requires redeploying the Revit add-in (`scripts\deploy.ps1` with Revit closed, then
+restart Revit).
+
+## [0.2.16] - 2026-08-21
+
+### Fixed
+- `search_api_docs`: an accessor-spelling query combined with `kind: "method"` — e.g.
+  `Element.get_Parameter(BuiltInParameter)` filtered to methods — returned "no matches",
+  because the accessor rewrite found the documented member but the kind filter rejected it:
+  a C# `get_X`/`set_X` accessor is a method to the caller, while the XML documents the
+  underlying member as a property or indexer. For accessor-rewritten candidates the
+  `method` filter now also admits properties, and the result note says so. Found by an
+  agent under a stress test that filtered its doc query to methods. Two benchmark probes
+  added (the widening plus a real-method control).
+
+Requires redeploying the Revit add-in (`scripts\deploy.ps1` with Revit closed, then
+restart Revit).
+
 ## [0.2.15] - 2026-08-21
 
 ### Fixed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-revit",
-  "version": "0.2.15",
+  "version": "0.2.17",
   "description": "Native Pi connector for Autodesk Revit. Run npx.cmd -y pi-revit for the full Windows install.",
   "author": "Ahmad Altahlawi",
   "license": "MIT",
@@ -26,7 +26,8 @@
   "scripts": {
     "deploy": "powershell -ExecutionPolicy Bypass -File scripts/deploy.ps1",
     "setup": "powershell -ExecutionPolicy Bypass -File scripts/setup-workspace.ps1",
-    "uninstall:revit": "powershell -ExecutionPolicy Bypass -File scripts/uninstall.ps1"
+    "uninstall:revit": "powershell -ExecutionPolicy Bypass -File scripts/uninstall.ps1",
+    "test:search": "dotnet run --project tests/search-engine"
   },
   "files": [
     "bin/",

package/scripts/benchmark-search-docs.py

@@ -31,8 +31,10 @@ else:
     XML_PATH = candidates[-1]
 
 LAT = []
-def search(query, max_results=10):
-    body = json.dumps({"query": query, "max_results": max_results}).encode("utf-8")
+def search(query, max_results=10, kind=None):
+    args = {"query": query, "max_results": max_results}
+    if kind: args["kind"] = kind
+    body = json.dumps(args).encode("utf-8")
     url = f"{BASE}/tools/search_api_docs/execute?token={TOKEN}&timeout_ms=60000"
     req = urllib.request.Request(url, data=body, headers={"content-type": "application/json"}, method="POST")
     t0 = time.perf_counter()
@@ -180,8 +182,8 @@ R["B signature+spacing"] = B
 
 # --------------------------------------------------------- C: complex syntax shapes
 C = {"cases": []}
-def probe(label, q, expect_nonzero=True):
-    try: matches, total = search(q)
+def probe(label, q, expect_nonzero=True, kind=None):
+    try: matches, total = search(q, kind=kind)
     except Exception as e:
         C["cases"].append((label, q, f"ERROR {e}")); return
     ok = (total > 0) if expect_nonzero else (total == 0)
@@ -213,6 +215,9 @@ probe("factory honesty control", "Document.Create.Banana", expect_nonzero=False)
 probe("accessor indexer", "Element.get_Parameter(BuiltInParameter")
 probe("accessor property", "Element.get_BoundingBox(View")
 probe("literal get_ member", "LocationCurve.get_ElementsAtJoin")
+# 0.2.16: kind=method on an accessor query admits the documented property
+probe("accessor with kind=method", "Element.get_Parameter(BuiltInParameter", kind="method")
+probe("kind=method control (real method)", "Wall.Create(Document, Curve", kind="method")
 print("C done", flush=True)
 R["C complex-syntax"] = C
 

package/skills/pi-revit/SKILL.md

@@ -31,7 +31,7 @@ Workflow guidance:
 - `get_elements` is the listing/counting primitive (`count_only: true` for bare counts). It returns identity fields only (id, name, category, typeName, levelId); read parameter values with `get_element_details`. Prefer a `category` or `of_class` scope when filtering by a parameter's display name.
 - The selection pipeline is `get_elements` -> ids -> `manage_selection` (action `set`); there is no inline filter on selection.
 - `set_parameters` is the home for bulk parameter writes AND renames (the `Name` parameter covers levels, views, sheets, types). One transaction per batch; per-element failures are reported. Pass `expected_document` (the model title) when several models are open or the session is long — it makes the write fail cleanly instead of landing in a different active document.
-- Parameter display names are LOCALIZED: in a non-English Revit UI, `Mark` is `Kennzeichen` (German), `マーク` (Japanese), etc. When a display-name lookup or `parameter_names` filter finds nothing, or the document may be non-English, use the language-independent `BuiltInParameter` enum name instead (e.g. `ALL_MODEL_MARK` for Mark, `ALL_MODEL_INSTANCE_COMMENTS` for Comments) — `set_parameters`, `get_element_details.parameter_names`, and `get_elements` filter rules all accept them, and `get_element_details` reports each parameter's `builtInParameter` name for discovery.
+- Parameter display names are LOCALIZED: in a non-English Revit UI, `Mark`, `Comments`, and every other display name appear under their translated names. When a display-name lookup or `parameter_names` filter finds nothing, or the document may be non-English, use the language-independent `BuiltInParameter` enum name instead (e.g. `ALL_MODEL_MARK` for Mark, `ALL_MODEL_INSTANCE_COMMENTS` for Comments) — `set_parameters`, `get_element_details.parameter_names`, and `get_elements` filter rules all accept them, and `get_element_details` reports each parameter's `builtInParameter` name for discovery.
 - Before writing `execute_csharp` code, verify unfamiliar classes/members with `search_api_docs` (works with no document open; first query builds the index and takes a few seconds). The top match carries its remarks, parameter docs, and returns inline, and every public API enum value is searchable — trust the result over guessing or web search; narrow the query to promote a different match into the top slot.
 - `export_documents` files its output under `Documents\pi-revit\Models\<model title>\exports` automatically when `output_dir` is omitted — keyed to the exported document, so it lands right even across many models. Pass `output_dir` only when the user names a different target.
 

package/src/Revit/Application.cs

@@ -1,3 +1,4 @@
+using Autodesk.Revit.DB;
 using Autodesk.Revit.UI;
 using RevitApplication = Autodesk.Revit.ApplicationServices.Application;
 
@@ -67,7 +68,32 @@ namespace RevitBridge
         {
             if (sender is RevitApplication app)
                 _application = app;
-            _hasOpenDocument = (_application?.Documents?.Size ?? 0) > 0;
+            try
+            {
+                // Linked documents count in Documents but are never the active UI
+                // document -- with only links loaded, ExternalEvents still are not
+                // pumped, so counting them would let a queued call hang for its full
+                // timeout instead of failing fast with the 409.
+                bool any = false;
+                var documents = _application?.Documents;
+                if (documents != null)
+                {
+                    foreach (Document document in documents)
+                    {
+                        if (!document.IsLinked)
+                        {
+                            any = true;
+                            break;
+                        }
+                    }
+                }
+                _hasOpenDocument = any;
+            }
+            catch
+            {
+                // Transitional states (mid-close) can make the iteration throw; keep
+                // the last known value -- the in-queue backstop still catches a miss.
+            }
         }
 
         private static string StartupErrorPath() =>

package/src/Revit/Tools/GetElementDetails.cs

@@ -27,7 +27,7 @@ namespace RevitBridge.Tools
                 {
                     type = "array",
                     items = new { type = "string" },
-                    description = "Only return these parameters. Matches the display name OR the BuiltInParameter enum name (case-insensitive exact). Display names are localized (e.g. 'Mark' is 'Kennzeichen' in a German UI) — prefer enum names like ALL_MODEL_MARK for language-independent filtering. Default: all.",
+                    description = "Only return these parameters. Matches the display name OR the BuiltInParameter enum name (case-insensitive exact). Display names are localized in non-English Revit UIs — prefer enum names like ALL_MODEL_MARK for language-independent filtering. Default: all.",
                 },
                 include = new
                 {

package/src/Revit/Tools/SearchApiDocs.cs

@@ -142,17 +142,17 @@ namespace RevitBridge.Tools
             // member, before giving up. Deterministic rewrites of an exact idiom — never
             // applied unless the literal 'document.create.' / 'application.create.' prefix
             // is present, so ordinary names like Wall.Create are untouched.
-            var candidates = new List<(string Query, string? Note)> { (q, null) };
+            var candidates = new List<(string Query, string? Note, bool AccessorRewrite)> { (q, null, false) };
             foreach (string factory in new[] { "document.create.", "application.create." })
             {
                 if (!q.StartsWith(factory, StringComparison.Ordinal))
                     continue;
                 string owner = factory[..(factory.IndexOf('.') + 1)];         // "document."
                 string rest = q[factory.Length..];
-                candidates.Add((owner + rest, $"'{owner}Create.*' is the Creation factory — matched as '{owner}{rest}'."));
+                candidates.Add((owner + rest, $"'{owner}Create.*' is the Creation factory — matched as '{owner}{rest}'.", false));
                 string bareMember = rest.Split('(')[0];
                 if (bareMember.Length > 0)
-                    candidates.Add((bareMember, $"'{owner}Create.{bareMember}' is a Creation-factory call; its docs live on the factory class (e.g. ItemFactoryBase) — matched by member name '{bareMember}'."));
+                    candidates.Add((bareMember, $"'{owner}Create.{bareMember}' is a Creation-factory call; its docs live on the factory class (e.g. ItemFactoryBase) — matched by member name '{bareMember}'.", false));
             }
 
             // C# spells property and indexer accessors 'get_X'/'set_X' (element.get_Parameter(...),
@@ -166,26 +166,33 @@ namespace RevitBridge.Tools
                 if (accessor.StartsWith("get_", StringComparison.Ordinal) || accessor.StartsWith("set_", StringComparison.Ordinal))
                     accessor = accessor["get_".Length..];
                 if (accessor != q)
-                    candidates.Add((accessor, "'get_X' / 'set_X' is the C# accessor spelling of property or indexer 'X'; matched without the prefix."));
+                    candidates.Add((accessor, "'get_X' / 'set_X' is the C# accessor spelling of property or indexer 'X'; matched without the prefix.", true));
             }
 
-            foreach (var (candidate, note) in candidates)
+            foreach (var (candidate, note, accessorRewrite) in candidates)
             {
-                var (top, total) = RunScoring(index, candidate, kindFilter, maxResults);
+                // A C# accessor IS a method to the caller ('element.get_Parameter(...)'), but
+                // the XML documents the underlying member as a property/indexer — so an
+                // accessor-rewritten candidate lets kind=method admit properties too.
+                bool widenKind = accessorRewrite && kindFilter == 'M';
+                var (top, total) = RunScoring(index, candidate, kindFilter, maxResults, widenKind);
                 if (total > 0)
-                    return (top, total, note);
+                    return (top, total, widenKind
+                        ? note + " The 'method' kind filter also admitted properties here: accessors are documented as properties/indexers."
+                        : note);
             }
             return (new List<ApiMember>(), 0, null);
         }
 
-        private static (List<ApiMember> Top, int Total) RunScoring(DocIndex index, string q, char? kindFilter, int maxResults)
+        private static (List<ApiMember> Top, int Total) RunScoring(DocIndex index, string q, char? kindFilter, int maxResults, bool methodKindAdmitsProperties = false)
         {
             string[] words = q.Split(WordSeparators, StringSplitOptions.RemoveEmptyEntries);
 
             var scored = new List<(ApiMember Member, int Score)>();
             foreach (var member in index.Members)
             {
-                if (kindFilter is { } kind && member.Kind != kind)
+                if (kindFilter is { } kind && member.Kind != kind
+                    && !(methodKindAdmitsProperties && kind == 'M' && member.Kind == 'P'))
                     continue;
                 int score = Score(member, q, words);
                 if (score > 0)