Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions gateway/run.py
Original file line number Diff line number Diff line change
Expand Up @@ -11958,6 +11958,12 @@ def _run_still_current() -> bool:
if not isinstance(_tool_friendly_names, dict):
_tool_friendly_names = {}

# Tools whose preview (query/argument) should still be shown even when
# a friendly name is active. By default, tools with a friendly name
# suppress previews (raw shell commands, file paths, etc. are noise for
# end users). List tool names here to opt back in.
_tool_show_preview = set(display_config.get("tool_show_preview") or [])
Comment thread
exiao marked this conversation as resolved.
Outdated

def progress_callback(event_type: str, tool_name: str = None, preview: str = None, args: dict = None, **kwargs):
"""Callback invoked by agent on tool lifecycle events."""
if not progress_queue or not _run_still_current():
Expand Down Expand Up @@ -12022,10 +12028,14 @@ def progress_callback(event_type: str, tool_name: str = None, preview: str = Non
from agent.display import get_tool_emoji
emoji = get_tool_emoji(tool_name, default="⚙️")
display_name = _tool_friendly_names.get(tool_name, tool_name or "")
_has_friendly = tool_name in _tool_friendly_names
_suppress_preview = _has_friendly and tool_name not in _tool_show_preview

# Verbose mode: show detailed arguments, respects tool_preview_length
if progress_mode == "verbose":
if args:
if _suppress_preview:
msg = f"{emoji} {display_name}..."
elif args:
from agent.display import get_tool_preview_max_len
_pl = get_tool_preview_max_len()
args_str = json.dumps(args, ensure_ascii=False, default=str)
Expand All @@ -12045,7 +12055,9 @@ def progress_callback(event_type: str, tool_name: str = None, preview: str = Non
# "all" / "new" modes: short preview, respects tool_preview_length
# config (defaults to 40 chars when unset to keep gateway messages
# compact — unlike CLI spinners, these persist as permanent messages).
if preview:
if _suppress_preview:
msg = f"{emoji} {display_name}..."
elif preview:
from agent.display import get_tool_preview_max_len
_pl = get_tool_preview_max_len()
_cap = _pl if _pl > 0 else 40
Expand Down
50 changes: 48 additions & 2 deletions tests/test_tool_friendly_names.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,18 @@ def _build_progress_callback(display_config=None, progress_queue=None):
if not isinstance(_tool_friendly_names, dict):
_tool_friendly_names = {}

_tool_show_preview = set(display_config.get("tool_show_preview") or [])

def progress_callback(tool_name, preview=None, args=None):
from agent.display import get_tool_emoji
emoji = get_tool_emoji(tool_name, default="⚙️")
display_name = _tool_friendly_names.get(tool_name, tool_name)
display_name = _tool_friendly_names.get(tool_name, tool_name or "")
_has_friendly = tool_name in _tool_friendly_names
_suppress_preview = _has_friendly and tool_name not in _tool_show_preview

if preview:
if _suppress_preview:
msg = f"{emoji} {display_name}..."
elif preview:
msg = f'{emoji} {display_name}: "{preview}"'
else:
msg = f"{emoji} {display_name}..."
Expand Down Expand Up @@ -93,3 +99,43 @@ def test_non_dict_friendly_names_ignored(self):
cb, q = _build_progress_callback(display_config=config)
msg = cb("WebSearch", preview="test")
assert "WebSearch" in msg

# --- Preview suppression tests ---

def test_friendly_name_suppresses_preview_by_default(self):
"""Tools with a friendly name hide their preview (raw args are noise)."""
config = {"tool_friendly_names": {"terminal": "Looking up data"}}
cb, q = _build_progress_callback(display_config=config)
msg = cb("terminal", preview="scripts/serper.sh 'AAPL'")
assert "Looking up data..." in msg
assert "serper" not in msg

def test_show_preview_opts_tool_back_in(self):
"""tool_show_preview list re-enables preview for specific tools."""
config = {
"tool_friendly_names": {"WebSearch": "Searching the web"},
"tool_show_preview": ["WebSearch"],
}
cb, q = _build_progress_callback(display_config=config)
msg = cb("WebSearch", preview="AAPL earnings")
assert "Searching the web" in msg
assert "AAPL earnings" in msg

def test_unmapped_tool_still_shows_preview(self):
"""Tools without a friendly name always show preview (no suppression)."""
config = {"tool_friendly_names": {"terminal": "Looking up data"}}
cb, q = _build_progress_callback(display_config=config)
msg = cb("WebSearch", preview="AAPL earnings")
assert "WebSearch" in msg
assert "AAPL earnings" in msg

def test_show_preview_empty_list(self):
"""Empty tool_show_preview = all friendly-named tools suppress preview."""
config = {
"tool_friendly_names": {"terminal": "Looking up data"},
"tool_show_preview": [],
}
cb, q = _build_progress_callback(display_config=config)
msg = cb("terminal", preview="/root/.hermes/scripts/foo.sh")
assert "Looking up data..." in msg
assert "/root" not in msg
Loading