Files
hermes-agent/tools/tip_tool.py
T
Teknium 95505c60e9 docs(tools): lead every tool description with its key capability
The deferred tool_search catalog shows each tool's first sentence clipped to
60 chars, so lines like 'image_generate: Generate high-quality images from
text prompts, or edit /…' hid that it edits with reference images on the
user's configured model. An agent skipped it and called FAL directly with a
hardcoded model.

- catalog line cap 60 -> 80 (CATALOG_SUMMARY_MAX_CHARS); every built-in
  tool's first sentence now fits and leads with what it does
- image_generate/video_generate say they use the configured model;
  image_generate says to use it rather than direct API calls/scripts
- web_search/web_extract/browser_exec name when to use each other
- drop a duplicated cronjob sentence and filler in skill_view/video_generate
- regenerate tests/fixtures/prompt_surface
2026-10-23 16:04:50 -07:00

81 lines
3.1 KiB
Python

"""Point at something in the Hermes desktop GUI and say one line about it — the quiet
sibling of ``tour`` (same ``data-tour`` handles) with no scrim/spotlight/paging.
Fire-and-forget: a tip is not a question, so blocking on a round-trip would stall the
reply. Lives in ``desktop_ui`` and withdraws itself when the user turns tips off."""
import json
from tools import desktop_ui
from tools.registry import registry, tool_error
SIDES = ("top", "right", "bottom", "left")
def tip_tool(text: str, selector: str, title: str = "", side: str = "") -> str:
"""Show one tip bubble anchored to ``selector``."""
text = (text or "").strip()
selector = (selector or "").strip()
if not text:
return tool_error("tip needs text — the one line the bubble says.")
if not selector:
return tool_error("tip needs a selector to point at. Call tour(action='targets') to see "
"what's on screen and prefer a target reporting stable: true.")
if side and side not in SIDES:
return tool_error(f"side must be one of: {', '.join(SIDES)}.")
payload = {"selector": selector, "text": text,
**{k: v for k, v in (("title", title), ("side", side)) if v}}
try:
ok = desktop_ui.emit("tip.show", payload)
except Exception as exc:
return tool_error(f"Failed to show the tip: {exc}")
if not ok:
return tool_error("tip is only available in the Hermes desktop app.")
return json.dumps({"success": True, "selector": selector}, ensure_ascii=False)
TIP_SCHEMA = {
"name": "show_tip",
"description": (
"Point at one desktop UI element with a small arrow bubble (no dimming or tour). "
"For when a sentence is clearer with a finger on its subject. Get selectors from tour(action='targets'), "
"prefer stable:true, never guess. One tip at a time (new replaces "
"last); say the same thing in chat too — the bubble is a pointer, "
"not the message. Sparingly: a bubble every turn stops being read."
),
"parameters": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The one-sentence bubble text.",
},
"selector": {
"type": "string",
"description": "Selector from tour targets.",
},
"title": {
"type": "string",
"description": "Optional heading.",
},
"side": {
"type": "string",
"enum": list(SIDES),
"description": "Omit for 'top'; flips at screen edges.",
},
},
"required": ["text", "selector"],
},
}
def check_tips_enabled() -> bool:
"""The user's Settings → Appearance switch. On unless they turned it off."""
return desktop_ui.user_enabled("in_app_tips", default=True)
registry.register(
name="show_tip", toolset="desktop_ui", schema=TIP_SCHEMA, check_fn=check_tips_enabled,
handler=lambda args, **kw: tip_tool(
**{k: args.get(k, "") for k in ("text", "selector", "title", "side")}),
emoji="💡")