mirror of
https://github.com/HKUDS/nanobot.git
synced 2026-05-21 00:52:34 +00:00
e7798a28ee
Refactor Tool methods and type handling; introduce JSON Schema support for tool parameters (schema module, validation tests). Made-with: Cursor
113 lines
4.1 KiB
Python
113 lines
4.1 KiB
Python
"""Message tool for sending messages to users."""
|
|
|
|
from typing import Any, Awaitable, Callable
|
|
|
|
from nanobot.agent.tools.base import Tool, tool_parameters
|
|
from nanobot.agent.tools.schema import ArraySchema, StringSchema, tool_parameters_schema
|
|
from nanobot.bus.events import OutboundMessage
|
|
|
|
|
|
@tool_parameters(
|
|
tool_parameters_schema(
|
|
content=StringSchema("The message content to send"),
|
|
channel=StringSchema("Optional: target channel (telegram, discord, etc.)"),
|
|
chat_id=StringSchema("Optional: target chat/user ID"),
|
|
media=ArraySchema(
|
|
StringSchema(""),
|
|
description="Optional: list of file paths to attach (images, audio, documents)",
|
|
),
|
|
required=["content"],
|
|
)
|
|
)
|
|
class MessageTool(Tool):
|
|
"""Tool to send messages to users on chat channels."""
|
|
|
|
def __init__(
|
|
self,
|
|
send_callback: Callable[[OutboundMessage], Awaitable[None]] | None = None,
|
|
default_channel: str = "",
|
|
default_chat_id: str = "",
|
|
default_message_id: str | None = None,
|
|
):
|
|
self._send_callback = send_callback
|
|
self._default_channel = default_channel
|
|
self._default_chat_id = default_chat_id
|
|
self._default_message_id = default_message_id
|
|
self._sent_in_turn: bool = False
|
|
|
|
def set_context(self, channel: str, chat_id: str, message_id: str | None = None) -> None:
|
|
"""Set the current message context."""
|
|
self._default_channel = channel
|
|
self._default_chat_id = chat_id
|
|
self._default_message_id = message_id
|
|
|
|
def set_send_callback(self, callback: Callable[[OutboundMessage], Awaitable[None]]) -> None:
|
|
"""Set the callback for sending messages."""
|
|
self._send_callback = callback
|
|
|
|
def start_turn(self) -> None:
|
|
"""Reset per-turn send tracking."""
|
|
self._sent_in_turn = False
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
return "message"
|
|
|
|
@property
|
|
def description(self) -> str:
|
|
return (
|
|
"Send a message to the user, optionally with file attachments. "
|
|
"This is the ONLY way to deliver files (images, documents, audio, video) to the user. "
|
|
"Use the 'media' parameter with file paths to attach files. "
|
|
"Do NOT use read_file to send files — that only reads content for your own analysis."
|
|
)
|
|
|
|
async def execute(
|
|
self,
|
|
content: str,
|
|
channel: str | None = None,
|
|
chat_id: str | None = None,
|
|
message_id: str | None = None,
|
|
media: list[str] | None = None,
|
|
**kwargs: Any
|
|
) -> str:
|
|
from nanobot.utils.helpers import strip_think
|
|
content = strip_think(content)
|
|
|
|
channel = channel or self._default_channel
|
|
chat_id = chat_id or self._default_chat_id
|
|
# Only inherit default message_id when targeting the same channel+chat.
|
|
# Cross-chat sends must not carry the original message_id, because
|
|
# some channels (e.g. Feishu) use it to determine the target
|
|
# conversation via their Reply API, which would route the message
|
|
# to the wrong chat entirely.
|
|
if channel == self._default_channel and chat_id == self._default_chat_id:
|
|
message_id = message_id or self._default_message_id
|
|
else:
|
|
message_id = None
|
|
|
|
if not channel or not chat_id:
|
|
return "Error: No target channel/chat specified"
|
|
|
|
if not self._send_callback:
|
|
return "Error: Message sending not configured"
|
|
|
|
msg = OutboundMessage(
|
|
channel=channel,
|
|
chat_id=chat_id,
|
|
content=content,
|
|
media=media or [],
|
|
metadata={
|
|
"message_id": message_id,
|
|
} if message_id else {},
|
|
)
|
|
|
|
try:
|
|
await self._send_callback(msg)
|
|
if channel == self._default_channel and chat_id == self._default_chat_id:
|
|
self._sent_in_turn = True
|
|
media_info = f" with {len(media)} attachments" if media else ""
|
|
return f"Message sent to {channel}:{chat_id}{media_info}"
|
|
except Exception as e:
|
|
return f"Error sending message: {str(e)}"
|