Docs

Built-in tools›Handoff

Edit handoff note

edit_handoff_note
Group
Handoff
Turned on by
Its own switch on the Tools page of Conversation settings.
Approval
Not reviewed: runs without asking, within the limits on this page.
Profile key
tool.edit_handoff_note.description

Changes one passage of an existing handoff note and rewrites its line in the handoff index.

A conversation that continues another gets its own copy of the notes it inherited. When it reaches the Auto-compact threshold in turn, the model brings those notes up to date with this tool instead of writing new ones beside them. See Auto-compact.

Parameters

ParameterTypeDetails
description required
Description
stringOne sentence describing the note after the change, for its line in the handoff index.
name required
Name
stringExisting note name; the .md suffix is optional.
new_text required
New text
stringReplacement text; an empty string deletes the passage.
old_text required
Original text
stringPassage to replace; must occur exactly once in the note.

Edit this page on GitHub