fix: return modified arguments

Author: JoshParkSJ

src/uipath_langchain/agent/tools/tool_node.py

@@ -21,7 +21,7 @@
     extract_current_tool_call_index,
     find_latest_ai_message,
 )
-from uipath_langchain.chat.hitl import check_tool_confirmation
+from uipath_langchain.chat.hitl import request_tool_confirmation
 
 # the type safety can be improved with generics
 ToolWrapperReturnType = dict[str, Any] | Command[Any] | None
@@ -80,7 +80,10 @@ def _func(self, state: AgentGraphState) -> OutputType:
         if call is None:
             return None
 
-        confirmation = check_tool_confirmation(call, self.tool)
+        # HITL: prompt user for approval if tool requires confirmation
+        confirmation = request_tool_confirmation(call, self.tool)
+
+        # HITL cancelled: user rejected the tool call
         if confirmation is not None and confirmation.cancelled:
             return self._process_result(call, confirmation.cancelled)
 
@@ -93,6 +96,7 @@ def _func(self, state: AgentGraphState) -> OutputType:
             else:
                 result = self.tool.invoke(call)
             output = self._process_result(call, result)
+            # HITL approved: tag result with approved args (and whether they were modified)
             if confirmation is not None:
                 confirmation.annotate_result(output)
             return output
@@ -106,7 +110,10 @@ async def _afunc(self, state: AgentGraphState) -> OutputType:
         if call is None:
             return None
 
-        confirmation = check_tool_confirmation(call, self.tool)
+        # HITL: prompt user for approval if tool requires confirmation
+        confirmation = request_tool_confirmation(call, self.tool)
+
+        # HITL cancelled: user rejected the tool call
         if confirmation is not None and confirmation.cancelled:
             return self._process_result(call, confirmation.cancelled)
 
@@ -119,6 +126,7 @@ async def _afunc(self, state: AgentGraphState) -> OutputType:
             else:
                 result = await self.tool.ainvoke(call)
             output = self._process_result(call, result)
+            # HITL approved: tag result with approved args (and whether they were modified)
             if confirmation is not None:
                 confirmation.annotate_result(output)
             return output

src/uipath_langchain/chat/hitl.py

@@ -1,5 +1,6 @@
 import functools
 import inspect
+import json
 from inspect import Parameter
 from typing import Annotated, Any, Callable, NamedTuple
 
@@ -12,7 +13,6 @@
 )
 
 CANCELLED_MESSAGE = "Cancelled by user"
-ARGS_MODIFIED_MESSAGE = "Tool arguments were modified by the user"
 
 CONVERSATIONAL_APPROVED_TOOL_ARGS = "conversational_approved_tool_args"
 REQUIRE_CONVERSATIONAL_CONFIRMATION = "require_conversational_confirmation"
@@ -39,8 +39,18 @@ def annotate_result(self, output: dict[str, Any] | Any) -> None:
                 self.approved_args
             )
         if self.args_modified:
-            msg.content = (
-                f'{{"meta": "{ARGS_MODIFIED_MESSAGE}", "result": {msg.content}}}'
+            try:
+                result_value = json.loads(msg.content)
+            except (json.JSONDecodeError, TypeError):
+                result_value = msg.content
+            msg.content = json.dumps(
+                {
+                    "meta": {
+                        "args_modified_by_user": True,
+                        "executed_args": self.approved_args,
+                    },
+                    "result": result_value,
+                }
             )
 
 
@@ -127,9 +137,10 @@ def request_approval(
     )
 
 
-def check_tool_confirmation(
+def request_tool_confirmation(
     call: ToolCall, tool: BaseTool
 ) -> ConfirmationResult | None:
+    """Check whether a tool requires user confirmation and request approval"""
     if not (tool.metadata and tool.metadata.get(REQUIRE_CONVERSATIONAL_CONFIRMATION)):
         return None
 
@@ -147,6 +158,7 @@ def check_tool_confirmation(
             original_args
         )
         return ConfirmationResult(cancelled=cancelled_msg, args_modified=False)
+    # Mutate call args so the tool executes with the approved values
     call["args"] = approved_args
     return ConfirmationResult(
         cancelled=None,

src/uipath_langchain/runtime/messages.py

@@ -60,7 +60,7 @@ def __init__(self, runtime_id: str, storage: UiPathRuntimeStorageProtocol | None
         """Initialize the mapper with empty state."""
         self.runtime_id = runtime_id
         self.storage = storage
-        self.confirmation_tool_names: set[str] = set[str]()
+        self.confirmation_tool_names: set[str] = set()
         self.current_message: AIMessageChunk
         self.seen_message_ids: set[str] = set()
         self._storage_lock = asyncio.Lock()
@@ -394,7 +394,7 @@ async def map_current_message_to_start_tool_call_events(self):
                         )
 
                         if tool_call["name"] not in self.confirmation_tool_names:
-                            # defer tool call for HITL
+                            # if tool requires HITL, we skip start tool call
                             events.append(
                                 self.map_tool_call_to_tool_call_start_event(
                                     self.current_message.id, tool_call
@@ -683,7 +683,6 @@ def _map_langchain_ai_message_to_uipath_message_data(
             role="assistant",
             content_parts=content_parts,
             tool_calls=uipath_tool_calls,
-            interrupts=[],  # interrupts are skipped during eval mode
         )
 
 

src/uipath_langchain/runtime/runtime.py

@@ -65,7 +65,7 @@ def __init__(
         self.entrypoint: str | None = entrypoint
         self.callbacks: list[BaseCallbackHandler] = callbacks or []
         self.chat = UiPathChatMessagesMapper(self.runtime_id, storage)
-        self.chat.confirmation_tool_names = self._detect_confirmation_tools()
+        self.chat.confirmation_tool_names = self._get_confirmation_tool_names()
         self._middleware_node_names: set[str] = self._detect_middleware_nodes()
 
     async def execute(
@@ -488,19 +488,17 @@ def _detect_middleware_nodes(self) -> set[str]:
 
         return middleware_nodes
 
-    def _detect_confirmation_tools(self) -> set[str]:
-        confirmation_tools: set[str] = set()
+    def _get_confirmation_tool_names(self) -> set[str]:
+        names: set[str] = set()
         for node_name, node_spec in self.graph.nodes.items():
-            bound = getattr(node_spec, "bound", None)
-            if bound is None:
-                continue
-            tool = getattr(bound, "tool", None)
+            # PregelNode.bound -> Runnable, Runnable.tool -> BaseTool (if tool node)
+            tool = getattr(getattr(node_spec, "bound", None), "tool", None)
             if tool is None:
                 continue
             metadata = getattr(tool, "metadata", None) or {}
             if metadata.get(REQUIRE_CONVERSATIONAL_CONFIRMATION):
-                confirmation_tools.add(getattr(tool, "name", node_name))
-        return confirmation_tools
+                names.add(getattr(tool, "name", node_name))
+        return names
 
     def _is_middleware_node(self, node_name: str) -> bool:
         """Check if a node name represents a middleware node."""

tests/agent/tools/test_tool_node.py

@@ -21,7 +21,6 @@
     create_tool_node,
 )
 from uipath_langchain.chat.hitl import (
-    ARGS_MODIFIED_MESSAGE,
     CANCELLED_MESSAGE,
     CONVERSATIONAL_APPROVED_TOOL_ARGS,
 )
@@ -551,7 +550,7 @@ def test_approved_same_args_no_meta(
         assert result is not None
         assert isinstance(result, dict)
         msg = result["messages"][0]
-        assert ARGS_MODIFIED_MESSAGE not in msg.content
+        assert "args_modified_by_user" not in msg.content
         assert "Mock result:" in msg.content
 
     @patch(
@@ -569,8 +568,12 @@ def test_approved_modified_args_injects_meta(
         assert result is not None
         assert isinstance(result, dict)
         msg = result["messages"][0]
-        assert ARGS_MODIFIED_MESSAGE in msg.content
-        assert "Mock result: edited" in msg.content
+        import json
+
+        wrapped = json.loads(msg.content)
+        assert wrapped["meta"]["args_modified_by_user"] is True
+        assert wrapped["meta"]["executed_args"] == {"input_text": "edited"}
+        assert "Mock result: edited" in wrapped["result"]
 
     @patch("uipath_langchain.chat.hitl.request_approval", return_value=None)
     async def test_async_cancelled(
@@ -601,8 +604,12 @@ async def test_async_approved_modified_args(
         assert result is not None
         assert isinstance(result, dict)
         msg = result["messages"][0]
-        assert ARGS_MODIFIED_MESSAGE in msg.content
-        assert "Async mock result: async edited" in msg.content
+        import json
+
+        wrapped = json.loads(msg.content)
+        assert wrapped["meta"]["args_modified_by_user"] is True
+        assert wrapped["meta"]["executed_args"] == {"input_text": "async edited"}
+        assert "Async mock result: async edited" in wrapped["result"]
 
     @patch(
         "uipath_langchain.chat.hitl.request_approval",

tests/chat/test_hitl.py

@@ -7,12 +7,11 @@
 from langchain_core.tools import BaseTool
 
 from uipath_langchain.chat.hitl import (
-    ARGS_MODIFIED_MESSAGE,
     CANCELLED_MESSAGE,
     CONVERSATIONAL_APPROVED_TOOL_ARGS,
     ConfirmationResult,
-    check_tool_confirmation,
     request_approval,
+    request_tool_confirmation,
 )
 
 
@@ -29,33 +28,33 @@ def _make_call(args: dict[str, Any] | None = None) -> ToolCall:
 
 
 class TestCheckToolConfirmation:
-    """Tests for check_tool_confirmation."""
+    """Tests for request_tool_confirmation."""
 
     def test_returns_none_when_no_metadata(self):
         """No metadata → no confirmation needed."""
         tool = MockTool()
         call = _make_call()
-        assert check_tool_confirmation(call, tool) is None
+        assert request_tool_confirmation(call, tool) is None
 
     def test_returns_none_when_flag_not_set(self):
         """Metadata exists but flag is missing → no confirmation needed."""
         tool = MockTool(metadata={"other_key": True})
         call = _make_call()
-        assert check_tool_confirmation(call, tool) is None
+        assert request_tool_confirmation(call, tool) is None
 
     def test_returns_none_when_flag_false(self):
         """Flag explicitly False → no confirmation needed."""
         tool = MockTool(metadata={"require_conversational_confirmation": False})
         call = _make_call()
-        assert check_tool_confirmation(call, tool) is None
+        assert request_tool_confirmation(call, tool) is None
 
     @patch("uipath_langchain.chat.hitl.request_approval", return_value=None)
     def test_cancelled_returns_tool_message(self, mock_approval):
         """User rejects → ConfirmationResult with cancelled ToolMessage and metadata."""
         tool = MockTool(metadata={"require_conversational_confirmation": True})
         call = _make_call()
 
-        result = check_tool_confirmation(call, tool)
+        result = request_tool_confirmation(call, tool)
 
         assert result is not None
         assert isinstance(result, ConfirmationResult)
@@ -78,7 +77,7 @@ def test_approved_same_args(self, mock_approval):
         tool = MockTool(metadata={"require_conversational_confirmation": True})
         call = _make_call({"query": "test"})
 
-        result = check_tool_confirmation(call, tool)
+        result = request_tool_confirmation(call, tool)
 
         assert result is not None
         assert result.cancelled is None
@@ -94,7 +93,7 @@ def test_approved_modified_args(self, mock_approval):
         tool = MockTool(metadata={"require_conversational_confirmation": True})
         call = _make_call({"query": "original"})
 
-        result = check_tool_confirmation(call, tool)
+        result = request_tool_confirmation(call, tool)
 
         assert result is not None
         assert result.cancelled is None
@@ -122,7 +121,7 @@ def test_annotate_sets_metadata(self):
         assert msg.content == "result"
 
     def test_annotate_wraps_content_when_modified(self):
-        """annotate_result wraps content when args were modified."""
+        """annotate_result wraps content with structured meta when args were modified."""
         confirmation = ConfirmationResult(
             cancelled=None, args_modified=True, approved_args={"query": "edited"}
         )
@@ -134,8 +133,12 @@ def test_annotate_wraps_content_when_modified(self):
         assert msg.response_metadata[CONVERSATIONAL_APPROVED_TOOL_ARGS] == {
             "query": "edited"
         }
-        assert ARGS_MODIFIED_MESSAGE in msg.content
-        assert "result" in msg.content
+        import json
+
+        wrapped = json.loads(msg.content)
+        assert wrapped["meta"]["args_modified_by_user"] is True
+        assert wrapped["meta"]["executed_args"] == {"query": "edited"}
+        assert wrapped["result"] == "result"
 
 
 class TestRequestApprovalTruthiness: