Skip to content

Build and run agents you can see, understand and trust.

fix(app): assign unique AG-UI message IDs to tool results (#2555)

guanyi liub82253ba1b68
diff --git a/src/agentscope/app/middleware/_protocol/_agui.py b/src/agentscope/app/middleware/_protocol/_agui.py
index 361790e39..e6909b806 100644
--- a/src/agentscope/app/middleware/_protocol/_agui.py
+++ b/src/agentscope/app/middleware/_protocol/_agui.py
@@ -56,7 +56,7 @@ class AGUIProtocolMiddleware(ProtocolMiddlewareBase):
# but not across concurrent requests. Use contextvars if
# concurrency is needed.
self._last_model_name: str = "model_call"
- self._tool_result_buffers: dict[str, list[str]] = {}
+ self._tool_result_buffers: dict[tuple[str, str], list[str]] = {}
def _convert_to_protocol(self, event: AgentEvent) -> dict:
"""Convert the AgentScope events into AGUI protocol."""
@@ -194,7 +194,7 @@ class AGUIProtocolMiddleware(ProtocolMiddlewareBase):
if isinstance(event, ToolResultTextDeltaEvent):
self._tool_result_buffers.setdefault(
- event.tool_call_id,
+ (event.reply_id, event.tool_call_id),
[],
).append(event.delta)
return AGUICustomEvent(
@@ -210,11 +210,17 @@ class AGUIProtocolMiddleware(ProtocolMiddlewareBase):
if isinstance(event, ToolResultEndEvent):
content = "".join(
- self._tool_result_buffers.pop(event.tool_call_id, []),
+ self._tool_result_buffers.pop(
+ (event.reply_id, event.tool_call_id),
+ [],
+ ),
)
+ # ``reply_id`` is shared by every tool result of one reply, so
+ # qualify it with ``tool_call_id`` to keep each result its own
+ # message.
return AGUIToolCallResultEvent(
tool_call_id=event.tool_call_id,
- message_id=event.reply_id,
+ message_id=f"{event.reply_id}:{event.tool_call_id}",
content=content or str(event.state),
)
diff --git a/tests/agui_protocol_test.py b/tests/agui_protocol_test.py
index c574edd07..60d6920a3 100644
--- a/tests/agui_protocol_test.py
+++ b/tests/agui_protocol_test.py
@@ -466,7 +466,7 @@ class AGUIProtocolToolResultTest(IsolatedAsyncioTestCase):
self.assertEqual(result["type"], "TOOL_CALL_RESULT")
self.assertEqual(result["toolCallId"], "tc_1")
- self.assertEqual(result["messageId"], "reply_1")
+ self.assertEqual(result["messageId"], "reply_1:tc_1")
self.assertEqual(result["content"], "partial result")
async def test_tool_result_end_fallback_to_state(self) -> None:
@@ -480,8 +480,53 @@ class AGUIProtocolToolResultTest(IsolatedAsyncioTestCase):
)
self.assertEqual(result["type"], "TOOL_CALL_RESULT")
+ self.assertEqual(result["messageId"], "reply_1:tc_1")
self.assertEqual(result["content"], "error")
+ async def test_multiple_tool_results_use_unique_message_ids(self) -> None:
+ """Test that two tool results of one reply get distinct ids."""
+ for tool_call_id, delta in (
+ ("tc_1", "result A"),
+ ("tc_2", "result B"),
+ ):
+ self.mw._convert_to_protocol(
+ ToolResultTextDeltaEvent(
+ reply_id="reply_1",
+ tool_call_id=tool_call_id,
+ delta=delta,
+ ),
+ )
+
+ results = [
+ self.mw._convert_to_protocol(
+ ToolResultEndEvent(
+ reply_id="reply_1",
+ tool_call_id=tool_call_id,
+ state=ToolResultState.SUCCESS,
+ ),
+ )
+ for tool_call_id in ("tc_2", "tc_1")
+ ]
+
+ self.assertListEqual(
+ results,
+ [
+ {
+ "type": "TOOL_CALL_RESULT",
+ "messageId": "reply_1:tc_2",
+ "toolCallId": "tc_2",
+ "content": "result B",
+ },
+ {
+ "type": "TOOL_CALL_RESULT",
+ "messageId": "reply_1:tc_1",
+ "toolCallId": "tc_1",
+ "content": "result A",
+ },
+ ],
+ )
+ self.assertDictEqual(self.mw._tool_result_buffers, {})
+
async def test_tool_result_start_to_custom(self) -> None:
"""Test ToolResultStartEvent -> CUSTOM."""
event = ToolResultStartEvent(