RéférenceOutils MCPforget

Tool Reference

forget

Supprimez un enregistrement vérifié de mémoire, de TODO ou de Ledger via la limite de contrôle détenue par l'utilisateur, avec une suppression réversible récupérable et une suppression définitive permanente.

Vérifier une suppression

Réexécutez la recherche qui renvoyait précédemment la mémoire. La suppression n'est confirmée que lorsque l'entrée n'apparaît plus.

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

Outil MCP public

forget

Objectif

Supprimer une mémoire, un TODO ou un enregistrement adossé à Ledger sélectionné via la limite de contrôle détenue par l'utilisateur. Le contrat public couvre uniquement les suppressions réversible et définitive ; utilisez redact_memory pour remplacer le contenu sur place.

Quand l'utiliser

  • Un utilisateur demande explicitement de supprimer un enregistrement examiné et fournit une référence exacte lorsque cela est possible.
  • L'appelant a besoin d'une suppression récupérable, qui est le comportement public par défaut, ou d'une suppression définitive explicitement confirmée.
  • Un ID de TODO ou de transaction Ledger connu doit être supprimé via le même cycle de vie régi.

Quand NE PAS l'utiliser

  • Ne l'utilisez pas pour caviarder ou remplacer du contenu : l'outil public forget rejette replacement_content ; appelez plutôt redact_memory.
  • N'utilisez pas une requête approximative pour nettoyer des données en masse ; résolvez et examinez d'abord une cible exacte.
  • N'utilisez pas mode=hard à moins que l'utilisateur ne confirme explicitement une suppression définitive et irréversible.
  • Ne l'utilisez pas pour réviser le contenu d'une mémoire ; utilisez un flux de travail de mise à jour/correction lorsqu'il est disponible.
  • L'API REST accepte un ensemble de champs plus large que l'outil MCP public ; consultez /docs/api/memory pour les filtres de périmètre, bucket, équipe et provenance.

Périmètre requis

  • forget public requiert memory:write ; la politique de déploiement peut nécessiter une capacité destructive supplémentaire pour la suppression définitive.
  • L'appelant doit être autorisé pour la limite propriétaire/équipe/périmètre de la cible.

Paramètres

NomTypeDescription
memory_idstringRéférence exacte de l'enregistrement à supprimer. Préférée à target.
targetstringCible descriptive lorsqu'aucune référence exacte n'est disponible.
modestring · par défaut : soft'soft' (par défaut, récupérable) ou 'hard' (permanent, requiert d'abord une confirmation explicite de l'utilisateur). Les alias 'soft_delete' et 'hard_delete' sont acceptés, et une valeur vide signifie soft. Toute autre valeur est rejetée.
reasonstringMotif court d'audit consigné avec la suppression.

Schéma de retour

Le texte de succès indique la référence opaque concernée et l'état du cycle de vie. La suppression réversible reste récupérable via le chemin de restauration ; ce n'est pas le cas de la suppression définitive.

Exemples

Supprimer de manière réversible un enregistrement exact
forget({
  target: "memory-id-from-recall",
  mode: "soft",
  reason: "User requested removal"
})

Erreurs

  • Échec de validation : un mode autre que 'soft'/'soft_delete'/'hard'/'hard_delete' est fourni, ou replacement_content est défini (utilisez redact_memory).
  • 401/403 : le jeton ne dispose pas de la capacité d'écriture/suppression requise ou ne peut pas accéder à la cible.
  • Cible ambiguë : query_hint correspond à plusieurs enregistrements ou aucune cible exacte ne peut être établie.
  • Mode invalide : la suppression définitive n'est pas déduite implicitement, et les modes non pris en charge sont rejetés sur la surface publique.
  • Non trouvé ou conflit de cycle de vie : la mémoire, le TODO ou l'enregistrement Ledger sélectionné est déjà absent ou modifié.
  • search_memory — Trouver un résultat strict et autorisé avant une action destructive.
  • remember — Créer un nouvel enregistrement durable uniquement lorsqu'il est réellement nécessaire.
  • todos — Gérer directement l'état des tâches ; n'utilisez forget que pour une suppression examinée.
  • ledger — Gérer les enregistrements financiers via le répartiteur régi de Ledger.

Source : Commandes de la console Memory Console