Skip to content

docs: document the recall tool - #417

Merged
obra merged 3 commits into
obra:mainfrom
ada-sen:docs/recall-tool
Sep 30, 2026
Merged

obra merged 3 commits into
obra:mainfrom
ada-sen:docs/recall-tool

Conversation

@ada-sen

@ada-sen ada-sen commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Documents the built-in recall tool (actions, params, defaults, caps, indexed event types, redaction list, and error behaviors) at docs/features/recall.md, matching the style of docs/features/reminders.md. PRI-3257.

Review fixes (jc)

  • Exclusion syntax: FTS5 has no leading-- exclusion (here -foo fails with no such column: foo). The doc, the tool description, and the syntax-error hint in recall.ts now name NOT (e.g. deploy NOT staging). New tests pin that here NOT foo excludes and that the here -foo hint points at NOT. This PR now changes tool text in packages/agent, not only docs.
  • read.context is described as events on each side of the target.
  • Surrounding tool calls are capped at 10,000 characters with full: true, not uncapped.
  • The verbatim journal line is missing while an older session is still being backfilled (not "predates the journal table").
  • thread caps each event at about 4,000 bytes; a clipped event comes back as a truncated JSON string.
  • read reads transcript files; thread reads the verbatim event journal.
  • Redaction lists the prefixes actually matched; only sk-proj- OpenAI keys are covered.

@ada-sen
ada-sen marked this pull request as ready for review September 26, 2026 03:04
…g '-' claim

FTS5 has no leading-'-' exclusion: 'here -foo' fails with
'no such column: foo'. The tool description and the syntax-error hint
both advertised '-' as the exclusion syntax. They now name NOT
(e.g. 'deploy NOT staging') and say a leading '-' does not exclude.

Tests: 'here NOT foo' excludes the foo row, and the 'here -foo' error
hint no longer advertises '-' and points at NOT.
…on list

- NOT is the exclusion operator; a leading '-' fails as column syntax.
- read.context is a radius on each side of the target.
- Surrounding tool calls cap at 10,000 characters with full: true.
- The verbatim journal line is missing while a session is still being
  backfilled, not because the event predates the journal table.
- thread caps each event at about 4,000 bytes and returns a clipped
  event as a truncated JSON string.
- read reads transcript files; thread reads the event journal.
- List the token prefixes redaction actually matches (only sk-proj-
  OpenAI keys).
@obra
obra merged commit 0e19b2c into obra:main Sep 30, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants