Skip to content

Open-source Revit MCP server: let Claude and other AI assistants read and edit BIM models, with human approval on every change.

Reject mock-data fallback in live mode for selection_tools, model_inspector, familytype_mapper (#74)

A. Sam Mohammad332cbf41e685
diff --git a/packages/mcp-server-revit/src/revit_mcp_server/modules/familytype_mapper/module.py b/packages/mcp-server-revit/src/revit_mcp_server/modules/familytype_mapper/module.py
index ee4825f..225bfea 100644
--- a/packages/mcp-server-revit/src/revit_mcp_server/modules/familytype_mapper/module.py
+++ b/packages/mcp-server-revit/src/revit_mcp_server/modules/familytype_mapper/module.py
@@ -34,7 +34,8 @@ def _load_snapshot(snapshot_id: str, workspace: Any) -> Dict[str, Any]:
def _get_data(snapshot_id: str, workspace: Any):
if not snapshot_id:
- from revit_mcp_server.semantic.engine import generate_mock_snapshot
+ from revit_mcp_server.semantic.engine import generate_mock_snapshot, require_snapshot_or_mock
+ require_snapshot_or_mock(snapshot_id, "familytype_mapper")
snap = generate_mock_snapshot()
return (
[el.model_dump(by_alias=True) for el in snap.elements],
@@ -129,6 +130,7 @@ class FamilytypeMapperModule:
"inplace_count": len(inplace_families),
"findings_count": len(deduped),
"findings": deduped,
+ **({"data_source": "mock"} if not snapshot_id else {}),
}
def list_type_mappings(self, snapshot_id: str = "", category: str = "", workspace: Any = None, **_) -> Dict[str, Any]:
@@ -156,4 +158,5 @@ class FamilytypeMapperModule:
"category_filter": category or "(all)",
"families_count": len(result),
"mappings": result,
+ **({"data_source": "mock"} if not snapshot_id else {}),
}
diff --git a/packages/mcp-server-revit/src/revit_mcp_server/modules/model_inspector/module.py b/packages/mcp-server-revit/src/revit_mcp_server/modules/model_inspector/module.py
index 6efbf72..d3c420e 100644
--- a/packages/mcp-server-revit/src/revit_mcp_server/modules/model_inspector/module.py
+++ b/packages/mcp-server-revit/src/revit_mcp_server/modules/model_inspector/module.py
@@ -107,9 +107,12 @@ def _element_chip(el: Dict[str, Any]) -> Dict[str, Any]:
class ModelInspectorModule:
def summarize_model(self, snapshot_id: str = "", workspace: Any = None, **_) -> Dict[str, Any]:
+ is_mock = False
if not snapshot_id:
# Auto-take snapshot — call out to semantic module
- from revit_mcp_server.semantic.engine import generate_mock_snapshot
+ from revit_mcp_server.semantic.engine import generate_mock_snapshot, require_snapshot_or_mock
+ require_snapshot_or_mock(snapshot_id, "model_inspector")
+ is_mock = True
snap = generate_mock_snapshot()
elements = [el.model_dump(by_alias=True) for el in snap.elements]
types = [t.model_dump() for t in snap.types]
@@ -140,11 +143,15 @@ class ModelInspectorModule:
"family_count": len(family_set),
"by_category": dict(by_cat.most_common()),
"rooms": {"total": len(rooms), "placed": placed_rooms, "unplaced": len(rooms) - placed_rooms},
+ **({"data_source": "mock"} if is_mock else {}),
}
def ask(self, filter: Dict[str, Any], snapshot_id: str = "", workspace: Any = None, **_) -> Dict[str, Any]:
+ is_mock = False
if not snapshot_id:
- from revit_mcp_server.semantic.engine import generate_mock_snapshot
+ from revit_mcp_server.semantic.engine import generate_mock_snapshot, require_snapshot_or_mock
+ require_snapshot_or_mock(snapshot_id, "model_inspector")
+ is_mock = True
snap = generate_mock_snapshot()
elements = [el.model_dump(by_alias=True) for el in snap.elements]
else:
@@ -158,11 +165,15 @@ class ModelInspectorModule:
"filter": filter,
"matches_count": len(chips),
"elements": chips,
+ **({"data_source": "mock"} if is_mock else {}),
}
def list_groups(self, snapshot_id: str = "", workspace: Any = None, **_) -> Dict[str, Any]:
+ is_mock = False
if not snapshot_id:
- from revit_mcp_server.semantic.engine import generate_mock_snapshot
+ from revit_mcp_server.semantic.engine import generate_mock_snapshot, require_snapshot_or_mock
+ require_snapshot_or_mock(snapshot_id, "model_inspector")
+ is_mock = True
snap = generate_mock_snapshot()
elements = [el.model_dump(by_alias=True) for el in snap.elements]
else:
@@ -184,11 +195,15 @@ class ModelInspectorModule:
return {
"groups_count": len(group_list),
"groups": group_list,
+ **({"data_source": "mock"} if is_mock else {}),
}
def inspect_selection(self, element_uids: List[str], snapshot_id: str = "", workspace: Any = None, **_) -> Dict[str, Any]:
+ is_mock = False
if not snapshot_id:
- from revit_mcp_server.semantic.engine import generate_mock_snapshot
+ from revit_mcp_server.semantic.engine import generate_mock_snapshot, require_snapshot_or_mock
+ require_snapshot_or_mock(snapshot_id, "model_inspector")
+ is_mock = True
snap = generate_mock_snapshot()
elements = {el.uid: el.model_dump(by_alias=True) for el in snap.elements}
else:
@@ -239,6 +254,7 @@ class ModelInspectorModule:
"inspected_count": len(cards),
"missing_uids": missing,
"elements": cards,
+ **({"data_source": "mock"} if is_mock else {}),
}
def save_query(self, query_name: str, filter: Dict[str, Any], workspace: Any = None, **_) -> Dict[str, Any]:
diff --git a/packages/mcp-server-revit/src/revit_mcp_server/modules/selection_tools/module.py b/packages/mcp-server-revit/src/revit_mcp_server/modules/selection_tools/module.py
index 796c9cb..2958dc8 100644
--- a/packages/mcp-server-revit/src/revit_mcp_server/modules/selection_tools/module.py
+++ b/packages/mcp-server-revit/src/revit_mcp_server/modules/selection_tools/module.py
@@ -134,8 +134,11 @@ class SelectionToolsModule:
return self.set_selection(element_uids=element_uids, workspace=workspace)
def select_by_query(self, filter: Dict[str, Any], snapshot_id: str = "", workspace: Any = None, **_) -> Dict[str, Any]:
+ is_mock = False
if not snapshot_id:
- from revit_mcp_server.semantic.engine import generate_mock_snapshot
+ from revit_mcp_server.semantic.engine import generate_mock_snapshot, require_snapshot_or_mock
+ require_snapshot_or_mock(snapshot_id, "selection_tools")
+ is_mock = True
snap = generate_mock_snapshot()
elements = [el.model_dump(by_alias=True) for el in snap.elements]
else:
@@ -143,7 +146,10 @@ class SelectionToolsModule:
elements = data.get("elements", [])
matched_uids = [el["uid"] for el in elements if _match_element(el, filter)]
- return self.set_selection(element_uids=matched_uids, workspace=workspace)
+ result = self.set_selection(element_uids=matched_uids, workspace=workspace)
+ if is_mock:
+ result["data_source"] = "mock"
+ return result
def list_saved_selections(self, workspace: Any = None, **_) -> Dict[str, Any]:
selections = _load_selections(workspace)
@@ -204,8 +210,11 @@ class SelectionToolsModule:
# -----------------------------------------------------------------------
def _find_group(self, group_uid: str, snapshot_id: str, workspace: Any) -> Dict[str, Any]:
+ is_mock = False
if not snapshot_id:
- from revit_mcp_server.semantic.engine import generate_mock_snapshot
+ from revit_mcp_server.semantic.engine import generate_mock_snapshot, require_snapshot_or_mock
+ require_snapshot_or_mock(snapshot_id, "selection_tools")
+ is_mock = True
snap = generate_mock_snapshot()
elements = [el.model_dump(by_alias=True) for el in snap.elements]
else:
@@ -220,4 +229,5 @@ class SelectionToolsModule:
"current_name": group_el.get("type_name") if group_el else "<unknown>",
"member_count": len(member_elements),
"instance_count": 1, # Without a real Revit connection, assume 1 visible instance
+ **({"data_source": "mock"} if is_mock else {}),
}
diff --git a/packages/mcp-server-revit/tests/test_mock_fallback_guard.py b/packages/mcp-server-revit/tests/test_mock_fallback_guard.py
new file mode 100644
index 0000000..bcf5de5
--- /dev/null
+++ b/packages/mcp-server-revit/tests/test_mock_fallback_guard.py
@@ -0,0 +1,53 @@
+"""Mock-data fallback guard for selection_tools, model_inspector, familytype_mapper."""
+import importlib.util
+from pathlib import Path
+
+import pytest
+
+from revit_mcp_server.config import BridgeMode, config
+
+_ROOT = Path(__file__).parent.parent / "src/revit_mcp_server/modules"
+
+
+def _load(name: str, cls: str):
+ spec = importlib.util.spec_from_file_location(f"_{name}_guard", _ROOT / name / "module.py")
+ mod = importlib.util.module_from_spec(spec)
+ spec.loader.exec_module(mod)
+ return getattr(mod, cls)()
+
+
+class WS:
+ def __init__(self, p):
+ self.allowed_directories = [p]
+
+
+def ws(tmp_path):
+ return WS(tmp_path)
+
+
+CALLS = [
+ ("selection_tools", "SelectionToolsModule", "select_by_query", {"filter": {"category": "OST_Doors"}}),
+ ("selection_tools", "SelectionToolsModule", "_find_group", {"group_uid": "g1"}),
+ ("model_inspector", "ModelInspectorModule", "summarize_model", {}),
+ ("model_inspector", "ModelInspectorModule", "ask", {"filter": {"category": "OST_Doors"}}),
+ ("model_inspector", "ModelInspectorModule", "list_groups", {}),
+ ("model_inspector", "ModelInspectorModule", "inspect_selection", {"element_uids": ["x"]}),
+ ("familytype_mapper", "FamilytypeMapperModule", "audit_families", {}),
+ ("familytype_mapper", "FamilytypeMapperModule", "list_type_mappings", {}),
+]
+IDS = [f"{c[0]}.{c[2]}" for c in CALLS]
+
+
[email protected]("mod,cls,method,kwargs", CALLS, ids=IDS)
+def test_bridge_mode_without_snapshot_raises(mod, cls, method, kwargs, ws, monkeypatch):
+ monkeypatch.setattr(config, "mode", BridgeMode.bridge)
+ with pytest.raises(ValueError, match="requires a snapshot_id"):
+ getattr(_load(mod, cls), method)(snapshot_id="", workspace=ws, **kwargs)
+
+
[email protected]("mod,cls,method,kwargs", CALLS, ids=IDS)
+def test_mock_mode_without_snapshot_works_and_is_labelled(mod, cls, method, kwargs, ws, monkeypatch):
+ monkeypatch.setattr(config, "mode", BridgeMode.mock)
+ out = getattr(_load(mod, cls), method)(snapshot_id="", workspace=ws, **kwargs)
+ assert out["data_source"] == "mock"