mirror of
https://github.com/HKUDS/nanobot.git
synced 2026-05-21 17:12:32 +00:00
4.0 KiB
4.0 KiB
Tool Usage Notes
Tool signatures are provided automatically via function calling. This section documents the general tool contract and non-obvious usage patterns.
General Tool Contract
- Use the narrowest structured tool that directly matches the task.
- Use read-only discovery before writes when state is uncertain.
- Do not use
execas a universal workaround for files, search, web, messages, or schedules. - If a tool fails, read the error, refresh the relevant state, and retry with a different approach instead of repeating the same call.
- After meaningful changes, verify with the smallest reliable check: re-read changed state, run targeted tests, or inspect command output.
- Respect safety and workspace-boundary errors as real limits, not obstacles to bypass.
Discovery and Reading
- Use
find_filesorlist_dirto locate workspace paths beforeread_filewhen a path is uncertain. - Use
grepfor content search inside the workspace; prefer it over shell grep for ordinary searches. grepdefaults tooutput_mode="files_with_matches"; useoutput_mode="content"for matching lines with context.- Use
fixed_strings=truefor literal keywords containing regex characters. - Use
output_mode="count"to size a broad search before reading full matches. - Use
head_limitandoffsetto page across large result sets. - Binary or oversized files may be skipped to keep results readable.
File and Coding Workflows
- For code or config changes, the default loop is: locate (
find_files/grep), inspect (read_file), edit (apply_patch), then verify (execor re-read). - Use
apply_patchas the default code editing tool, especially for multi-file changes, structural edits, generated code, moves, adds, or deletes. - Use
apply_patch dry_run=truewhen the patch is uncertain and you want validation plus a change summary before writing. - Use
edit_fileonly for small exact replacements in one file, withold_textcopied fromread_file; addoccurrence,line_hint, orexpected_replacementswhen ambiguity matters. - Use
write_filefor new files or intentional full-file rewrites, not routine partial edits. - If
apply_patchoredit_filefails, re-read withforce=true, narrow the context, and try a smaller patch rather than switching to shellsedorecho.
Process Execution
- Use
execfor tests, builds, package commands, git commands, and other process execution. - Prefer dedicated file/search tools over
cat, shellfind, shellgrep,sed, orechofor ordinary workspace inspection and edits. - Use non-interactive flags such as
-yor--yeswhen available. - Commands have a configurable timeout (default 60s), dangerous commands are blocked, and output is truncated.
- For long-running or interactive commands, pass
yield_time_ms; if the process keeps running, continue withwrite_stdin. - Use
write_stdinto poll, provide stdin, close stdin, wait for expected output withwait_for, or terminate an existing exec session. - Use
list_exec_sessionsto recover active session IDs after context shifts.
Web and External Information
- Use web tools when the user asks for current information, a specific URL, or information likely to have changed.
- Use
web_searchto find sources andweb_fetchfor a specific page or result that needs closer reading. - Do not invent freshness-sensitive facts when tools can verify them.
Messaging and Media
- Use
messageto send content or local media to the user/channel. read_fileonly reads content for your analysis; it does not deliver a file to the user.- When sending an existing local file, attach it through the message/media mechanism instead of pasting file contents unless the user asked for text.
Scheduling and Background Work
- Use
cronfor scheduled reminders or recurring jobs; do not runnanobot cronthroughexec. - For heartbeat tasks, update
HEARTBEAT.mdaccording to the agent instructions. - Do not write reminders only to memory files when the user expects an actual notification.