リファレンスMCP ツールforget

Tool Reference

forget

ユーザー所有のcontrol boundaryを通じて、review済みのmemory、TODO、Ledger recordを削除します。soft deletionは復元可能で、hard deletionは恒久的です。

削除を検証する

以前そのmemoryを返したsearchをもう一度実行します。エントリが表示されなくなったときにだけ、削除が確認されます。

search_memory({ query: "<the removed content>", limit: 5 })
// -> the removed entry must be absent

公開 MCP ツール

forget

用途

ユーザー所有のcontrol boundaryを通じて、選択したmemory、TODO、Ledger-backed recordを削除します。Public contractはsoftとhard deletionだけを扱います。contentをその場で置き換えるにはredact_memoryを使います。

適用シーン

  • ユーザーがreview済みのrecordの削除を明示的に依頼し、可能ならexact referenceを指定した場合。
  • defaultのpublic behaviorである復元可能な削除、または明示的に確認された恒久削除が必要な場合。
  • 既知のTODOまたはLedger transaction IDを、同じgoverned lifecycleで削除する必要がある場合。

非推奨シーン

  • contentのredactや置換には使わないでください。public forgetはreplacement_contentを拒否するため、redact_memoryを呼び出します。
  • 推測したqueryでdataをbulk-cleanしないでください。先にexact targetを解決してreviewします。
  • ユーザーが恒久的で不可逆な削除を明示確認していない限り、mode=hardを使わないでください。
  • memory contentの修正には使わないでください。利用可能ならupdate/correction workflowを使います。
  • REST APIはpublic MCP toolより広いfield setを受け付けます。scope、bucket、team、provenance filterについては/docs/api/memoryを参照してください。

必須スコープ

  • Public forgetにはmemory:writeが必要です。deployment policyによってはhard deletionに追加のdestructive capabilityが必要です。
  • callerはtargetのowner/team/scope boundaryについて認可されていなければなりません。

パラメーター

名前型説明
memory_idstring削除するrecordのexact referenceです。targetより優先されます。
targetstringexact referenceを利用できない場合の説明用targetです。
modestring · デフォルト: soft「soft」（デフォルト、復元可能）または「hard」（恒久的で、事前に明示的なuser confirmationが必要）です。「soft_delete」と「hard_delete」aliasも受け付け、空の値はsoftを意味します。その他の値は拒否されます。
reasonstring削除と一緒に記録する短いaudit reasonです。

返却スキーマ

Success textは影響を受けたopaque referenceとlifecycle statusを報告します。Soft deletionはrestore pathで復元できますが、hard deletionは復元できません。

使用例

Exact recordを復元可能な形で削除する
forget({
  target: "memory-id-from-recall",
  mode: "soft",
  reason: "User requested removal"
})

エラー

  • Validation failure: 'soft'/'soft_delete'/'hard'/'hard_delete'以外のmodeが指定された、またはreplacement_contentが設定されています（redact_memoryを使います）。
  • 401/403: tokenに必要なwrite/delete capabilityがない、またはtargetにアクセスできません。
  • Ambiguous target: query_hintが複数のrecordに一致するか、exact targetを確定できません。
  • Invalid mode: hard deletionは推測されず、unsupported modeはpublic surfaceで拒否されます。
  • Not found or lifecycle conflict: 選択したmemory、TODO、Ledger recordがすでにないか、変更されています。
  • search_memory — destructive actionの前にstrictで認可されたresultを探します。
  • remember — 本当に必要な場合だけ新しい永続recordを作成します。
  • todos — task stateは直接管理し、review済みの削除にだけforgetを使います。
  • ledger — governed Ledger dispatcherでfinancial recordを管理します。

出典: Memory Consoleのコントロール