Open-source Revit MCP server: let Claude and other AI assistants read and edit BIM models, with human approval on every change.
Python aecai-agentsautodeskautomationbimclaudeifcmcpmcp-servermodel-context-protocolnavisworksrevitrevit-addinrevit-apirhino
fix(hub): close approval-gate coverage gap across all providers (R12)
A. Sam Mohammad2a131d8a94a8
diff --git a/packages/mcp-server-revit/src/revit_mcp_server/providers/base.py b/packages/mcp-server-revit/src/revit_mcp_server/providers/base.pyindex 9cf357f..63b69d8 100644--- a/packages/mcp-server-revit/src/revit_mcp_server/providers/base.py+++ b/packages/mcp-server-revit/src/revit_mcp_server/providers/base.py@@ -1,7 +1,37 @@from abc import ABC, abstractmethod-from typing import Dict, Any, List+from typing import Dict, Any, FrozenSet, Listfrom pydantic import BaseModel, Field++def enrich_mutation_metadata(+ tools: List["ProviderTool"],+ mutating_verbs: FrozenSet[str] = frozenset(),+ mutating_names: FrozenSet[str] = frozenset(),+ destructive: FrozenSet[str] = frozenset(),+) -> None:+ """Flag tools as `is_mutating` (and optionally `destructive`) in place.++ Two matching strategies, usable together: `mutating_verbs` matches any+ underscore-split part of the tool name (works well for providers whose tool+ names follow a `<provider>_<verb>_<noun>` convention, e.g. `revit_create_wall`);+ `mutating_names` matches exact tool names (safer for tool sets — e.g. Speckle/APS —+ where a generic verb list would either miss real mutations or false-positive on+ read verbs like `list`). `destructive` tool names get both flags set, mirroring+ how escape hatches like `revit_execute_python` are treated: mutating AND destructive.++ Every provider's write-capable tools MUST run through one of these so the+ ApprovalGate in mcp_server.py actually sees them — a tool that keeps the+ default `is_mutating=False` silently bypasses the approval gate entirely.+ """+ for tool in tools:+ name_parts = tool.name.split("_")+ if tool.name in mutating_names or any(verb in name_parts for verb in mutating_verbs):+ tool.is_mutating = True+ if tool.name in destructive:+ tool.is_mutating = True+ tool.destructive = True++class ProviderTool(BaseModel):name: strdescription: strdiff --git a/packages/mcp-server-revit/src/revit_mcp_server/providers/cloud.py b/packages/mcp-server-revit/src/revit_mcp_server/providers/cloud.pyindex cf19b12..2786936 100644--- a/packages/mcp-server-revit/src/revit_mcp_server/providers/cloud.py+++ b/packages/mcp-server-revit/src/revit_mcp_server/providers/cloud.py@@ -20,7 +20,7 @@ from specklepy.transports.server import ServerTransportfrom specklepy.api import operationsfrom specklepy.objects.base import Base-from .base import AECProvider, ProviderTool+from .base import AECProvider, ProviderTool, enrich_mutation_metadatafrom ..errors import RevitMCPErrorCredentialCallback = Callable[[str], str | None] | Callable[[str], Awaitable[str | None]]@@ -350,6 +350,13 @@ class OAuth2PKCETransport:class CloudProviderBase(AECProvider):provider_identity = "cloud"+ # Exact tool names that mutate remote state (create/publish/merge/send commits,+ # branches, models, or BCF issues). Matched by exact name rather than verb, since+ # this provider's tool names include read verbs (list/get) that a generic verb+ # matcher would need to carefully exclude — an explicit, auditable set is safer+ # for a fixed-size tool surface like this one. See providers/base.py for why every+ # provider must do this: an unflagged mutating tool bypasses the ApprovalGate.+ _mutating_tool_names: frozenset[str] = frozenset()def __init__(self,@@ -363,6 +370,7 @@ class CloudProviderBase(AECProvider):self._owns_client = http_client is Noneself._client = http_client or httpx.AsyncClient(transport=transport, timeout=timeout)self._capabilities = self._build_capabilities()+ enrich_mutation_metadata(self._capabilities, mutating_names=self._mutating_tool_names)def get_identity(self) -> str:return self.provider_identity@@ -440,6 +448,14 @@ class CloudProviderBase(AECProvider):class SpeckleProvider(CloudProviderBase):provider_identity = "speckle"+ _mutating_tool_names = frozenset({+ "speckle_create_model",+ "speckle_create_branch",+ "speckle_publish_version",+ "speckle_merge_model",+ "speckle_merge_branch",+ "speckle_send_object",+ })def __init__(self,@@ -810,6 +826,10 @@ class SpeckleProvider(CloudProviderBase):class AutodeskDataProvider(CloudProviderBase):provider_identity = "autodesk_data"+ _mutating_tool_names = frozenset({+ "autodesk_data_create_topic",+ "autodesk_data_create_issue",+ })def __init__(self,diff --git a/packages/mcp-server-revit/src/revit_mcp_server/providers/navisworks.py b/packages/mcp-server-revit/src/revit_mcp_server/providers/navisworks.pyindex 745c4fa..dd14d0f 100644--- a/packages/mcp-server-revit/src/revit_mcp_server/providers/navisworks.py+++ b/packages/mcp-server-revit/src/revit_mcp_server/providers/navisworks.py@@ -3,7 +3,7 @@ from typing import Any, Dict, Listfrom ..config import config, BridgeModefrom ..bridge.client import BridgeClientfrom ..security.workspace import WorkspaceMonitor-from .base import AECProvider, ProviderTool+from .base import AECProvider, ProviderTool, enrich_mutation_metadatalogger = logging.getLogger(__name__)@@ -25,11 +25,8 @@ class NavisworksProvider(AECProvider):self._enrich_tool_metadata()def _enrich_tool_metadata(self) -> None:- mutating_verbs = {"set", "invoke", "delete", "create", "move", "copy", "rotate", "mirror"}- for tool in self._capabilities:- name_parts = tool.name.split("_")- if any(verb in name_parts for verb in mutating_verbs):- tool.is_mutating = True+ mutating_verbs = {"set", "invoke", "delete", "create", "move", "copy", "rotate", "mirror", "run"}+ enrich_mutation_metadata(self._capabilities, mutating_verbs=mutating_verbs)def get_identity(self) -> str:return "navisworks"diff --git a/packages/mcp-server-revit/src/revit_mcp_server/providers/revit.py b/packages/mcp-server-revit/src/revit_mcp_server/providers/revit.pyindex aacf889..f30594d 100644--- a/packages/mcp-server-revit/src/revit_mcp_server/providers/revit.py+++ b/packages/mcp-server-revit/src/revit_mcp_server/providers/revit.py@@ -10,7 +10,7 @@ from ..bridge.client import BridgeClientfrom ..bridge.mock import MockBridgefrom ..security.workspace import WorkspaceMonitorfrom ..legacy.tools import TOOL_HANDLERS-from .base import AECProvider, ProviderTool+from .base import AECProvider, ProviderTool, enrich_mutation_metadatalogger = logging.getLogger(__name__)@@ -30,14 +30,8 @@ class RevitProvider(AECProvider):self._enrich_tool_metadata()def _enrich_tool_metadata(self) -> None:- mutating_verbs = {"create", "place", "set", "delete", "save", "close", "renumber", "duplicate", "move", "copy", "rotate", "mirror", "pin", "unpin", "sync", "relinquish", "convert", "edit", "apply", "change", "replace", "invoke"}- for tool in self._capabilities:- name_parts = tool.name.split("_")- if any(verb in name_parts for verb in mutating_verbs):- tool.is_mutating = True- if tool.name == "revit_execute_python":- tool.is_mutating = True- tool.destructive = True+ mutating_verbs = {"create", "place", "set", "delete", "save", "close", "renumber", "duplicate", "move", "copy", "rotate", "mirror", "pin", "unpin", "sync", "relinquish", "convert", "edit", "apply", "change", "replace", "invoke", "populate", "tag", "ungroup"}+ enrich_mutation_metadata(self._capabilities, mutating_verbs=mutating_verbs, destructive={"revit_execute_python"})def get_identity(self) -> str:return "revit"diff --git a/packages/mcp-server-revit/src/revit_mcp_server/providers/rhino.py b/packages/mcp-server-revit/src/revit_mcp_server/providers/rhino.pyindex d7a6d02..c0c7520 100644--- a/packages/mcp-server-revit/src/revit_mcp_server/providers/rhino.py+++ b/packages/mcp-server-revit/src/revit_mcp_server/providers/rhino.py@@ -4,7 +4,7 @@ from typing import Any, Dict, Listfrom ..config import config, BridgeModefrom ..bridge.client import BridgeClientfrom ..security.workspace import WorkspaceMonitor-from .base import AECProvider, ProviderTool+from .base import AECProvider, ProviderTool, enrich_mutation_metadatalogger = logging.getLogger(__name__)@@ -29,6 +29,16 @@ class RhinoProvider(AECProvider):bridge_factory = bridge_factory or (lambda u, t=None: BridgeClient(u, token=t))self._bridge = bridge_factory(url, None)self._init_tool_mapping()+ self._enrich_tool_metadata()++ def _enrich_tool_metadata(self) -> None:+ # rhino_run_python executes arbitrary IronPython with full RhinoCommon access —+ # same escape-hatch risk class as revit_execute_python, so it gets the same+ # mutating+destructive treatment. reflect_get/invoke_method/reflect_set are+ # left at the same risk level revit.py uses for their Revit-side equivalents+ # (mutating via the "invoke"/"set" verbs, not separately marked destructive).+ mutating_verbs = {"create", "clear", "set", "transform", "run", "boolean", "invoke"}+ enrich_mutation_metadata(self._capabilities, mutating_verbs=mutating_verbs, destructive={"rhino_run_python"})def get_identity(self) -> str:return "rhino"diff --git a/packages/mcp-server-revit/tests/test_provider_contract.py b/packages/mcp-server-revit/tests/test_provider_contract.pyindex e92a3af..f38d56f 100644--- a/packages/mcp-server-revit/tests/test_provider_contract.py+++ b/packages/mcp-server-revit/tests/test_provider_contract.py@@ -23,6 +23,7 @@ from revit_mcp_server.providers import (AutodeskDataProvider,JobProvider,SQLiteExporterProvider,+ NavisworksProvider,)try:from revit_mcp_server.providers import McpProxyProvider@@ -32,7 +33,6 @@ except ImportError:# Global registries to check uniqueness across all tests_all_provider_identities = set()_all_tool_names = {}-_missing_mutation_metadata = []# Parameterize over every registrable provider@pytest.fixture(scope="module")@@ -62,6 +62,7 @@ def shared_job_manager():"speckle","autodesk","rhino",+ "navisworks","proxy"])def provider_instance(request, shared_workspace_monitor, shared_provider_registry, shared_job_manager):@@ -87,6 +88,8 @@ def provider_instance(request, shared_workspace_monitor, shared_provider_registrreturn AutodeskDataProvider(client_id="dummy")elif name == "rhino":return RhinoProvider(workspace=shared_workspace_monitor)+ elif name == "navisworks":+ return NavisworksProvider(workspace=shared_workspace_monitor, mode=BridgeMode.mock)elif name == "proxy":if McpProxyProvider is None:pytest.skip("McpProxyProvider class is not importable/available.")@@ -139,12 +142,12 @@ async def test_provider_capabilities_and_tools(provider_instance):# Check if it has 'type' or 'properties'assert "type" in schema or "properties" in schema or schema == {}, f"Tool '{tool.name}' schema is not valid JSON-schema-shaped"- # 4. Mutating metadata check- mutating = getattr(tool, "mutating", None)- if mutating is None:- _missing_mutation_metadata.append((identity, tool.name))- else:- assert isinstance(mutating, bool)+ # 4. Mutating metadata shape check (correctness is asserted separately in+ # test_verb_matched_tools_are_flagged_mutating below — is_mutating is a bool+ # field with a default, so "missing" and "explicitly False" are indistinguishable+ # from the value alone; a prior version of this check used the wrong attribute+ # name (`mutating` instead of `is_mutating`) and asserted nothing as a result).+ assert isinstance(tool.is_mutating, bool)@pytest.mark.anyioasync def test_execute_unknown_tool_raises_typed_error(provider_instance):@@ -158,6 +161,56 @@ async def test_execute_unknown_tool_raises_typed_error(provider_instance):# Ensure it is a typed error (e.g. ValueError, KeyError, RevitMCPError)assert issubclass(excinfo.type, Exception)+# Verbs that, by convention across every provider's own enrichment call (see+# providers/base.py:enrich_mutation_metadata and each provider's mutating_verbs+# set), mark a tool as mutating. A provider with a write-shaped tool that never+# calls enrich_mutation_metadata at all (the exact bug found 2026-07 in+# RhinoProvider and the Speckle/APS cloud providers) will fail this test instead+# of silently bypassing the ApprovalGate — see docs/product/DECISIONS_AND_RISKS.md R12.+_MUTATING_VERBS = {+ "create", "place", "set", "delete", "save", "close", "renumber", "duplicate",+ "move", "copy", "rotate", "mirror", "pin", "unpin", "sync", "relinquish",+ "convert", "edit", "apply", "change", "replace", "invoke", "clear",+ "transform", "boolean", "run", "populate", "tag", "ungroup",+ "publish", "merge", "send",+}++# Tools intentionally exempt: they mutate only local, in-process, non-persistent+# state (an in-memory graph, an in-memory identity-mapping table) or write+# disposable workspace export artifacts. There is nothing for the ApprovalGate+# to protect there, and gating them would be pure friction with no safety+# benefit. Anything added here needs that same justification.+_MUTATION_GATE_EXEMPT = {+ "graph_add_relation", "graph_compile", # in-memory NetworkX graph only+ "aec_register_mapping", "aec_map_workspace_path", # in-memory identity table only+ "exporter_to_sqlite", "exporter_graph_to_sqlite", # workspace export artifact+ "snapshot_take", # workspace export artifact+ "job_cancel", # stops work, doesn't mutate a model+}+++async def test_verb_matched_tools_are_flagged_mutating(provider_instance):+ identity = provider_instance.get_identity()+ if identity == "proxy":+ health = await provider_instance.check_health()+ if health.get("status") == "disconnected":+ pytest.skip("Proxy provider is disconnected offline, skipping capabilities check.")++ for tool in provider_instance.get_capabilities():+ if tool.name in _MUTATION_GATE_EXEMPT:+ continue+ name_parts = tool.name.split("_")+ if any(verb in name_parts for verb in _MUTATING_VERBS):+ assert tool.is_mutating, (+ f"Tool '{tool.name}' on provider '{identity}' looks mutating "+ f"(name matches a known mutating verb) but is_mutating=False - "+ f"it would bypass the ApprovalGate entirely. Wire it through "+ f"enrich_mutation_metadata, or add it to _MUTATION_GATE_EXEMPT "+ f"above with a justification if it truly doesn't need gating."+ )++def test_redaction_contract():# Synthetic result matching typical structuresynthetic = {@@ -188,15 +241,3 @@ def test_redaction_contract():assert "C:\\Users\\sammo\\private.txt" not in redacted["nested"]["message"]assert "/Users/sammo/private.key" not in redacted["nested"]["message"]assert "<redacted-path>" in redacted["nested"]["message"]--def test_compile_mutation_metadata_report():- # This is a final test to print/log the report of tools missing mutation metadata- if _missing_mutation_metadata:- print("\n\n" + "="*50)- print("CONSOLIDATED REPORT: TOOLS MISSING MUTATION METADATA")- print("="*50)- for provider, tool in _missing_mutation_metadata:- print(f"Provider: {provider:15} | Tool: {tool}")- print("="*50 + "\n")- else:- print("\nAll tools have mutation metadata defined.\n")