ReferênciaFerramentas MCPforget

Tool Reference

forget

Exclua uma memória, um TODO ou um registro apoiado pelo Ledger por meio do limite de controle do usuário, após revisão; a exclusão lógica pode ser recuperada e a física é permanente.

Verifique uma exclusão

Execute novamente a busca que antes retornava a memória. A exclusão só é confirmada quando a entrada deixa de aparecer.

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

Ferramenta MCP pública

forget

Finalidade

Exclua uma memória, um TODO ou um registro apoiado pelo Ledger por meio do limite de controle do usuário. O contrato público cobre apenas exclusão lógica e física; use redact_memory para substituir o conteúdo no próprio registro.

Quando usar

  • O usuário pede explicitamente para remover um registro revisado e fornece uma referência exata quando possível.
  • O chamador precisa de uma exclusão recuperável, que é o comportamento público padrão, ou de uma exclusão permanente explicitamente confirmada.
  • Um ID conhecido de TODO ou de transação do Ledger precisa ser removido pelo mesmo ciclo de vida governado.

Quando NÃO usar

  • Não use para redigir ou substituir conteúdo: o forget público rejeita replacement_content; chame redact_memory.
  • Não use uma query_hint presumida para limpar dados em massa; primeiro resolva e revise um alvo exato.
  • Não use mode=hard sem a confirmação explícita do usuário para uma exclusão permanente e irreversível.
  • Não use para revisar o conteúdo de uma memória; use um fluxo de atualização/correção quando disponível.
  • A API REST aceita um conjunto de campos mais amplo que a ferramenta MCP pública; consulte /docs/api/memory para os filtros de scope, bucket, team e provenance.

Escopo necessário

  • O forget público exige memory:write; a política de implantação pode exigir uma capacidade destrutiva adicional para a exclusão física.
  • O chamador precisa estar autorizado no limite de owner/equipe/escopo do alvo.

Parâmetros

NomeTipoDescrição
memory_idstringReferência exata do registro a remover. Prefira-a a target.
targetstringAlvo descritivo quando não houver uma referência exata disponível.
modestring · padrão: soft'soft' (padrão, recuperável) ou 'hard' (permanente, exige confirmação explícita prévia do usuário). Os aliases 'soft_delete' e 'hard_delete' são aceitos, e um valor vazio significa soft. Qualquer outro valor é rejeitado.
reasonstringBreve motivo de auditoria registrado com a exclusão.

Esquema de retorno

O texto de sucesso informa a referência opaca afetada e o estado do ciclo de vida. A exclusão lógica continua recuperável pelo fluxo de restauração; a física não.

Exemplos

Remova um registro exato de forma recuperável
forget({
  target: "memory-id-from-recall",
  mode: "soft",
  reason: "User requested removal"
})

Erros

  • Falha de validação: foi informado um mode diferente de 'soft'/'soft_delete'/'hard'/'hard_delete' ou replacement_content foi definido (use redact_memory).
  • 401/403: o token não possui a capacidade necessária de gravação/exclusão ou não pode acessar o alvo.
  • Alvo ambíguo: query_hint corresponde a vários registros ou não foi possível estabelecer um alvo exato.
  • Modo inválido: a exclusão física não é inferida e modos não suportados são rejeitados na superfície pública.
  • Não encontrado ou conflito de ciclo de vida: a memória, o TODO ou o registro do Ledger selecionado já está ausente ou foi alterado.
  • search_memory — Encontre um resultado estrito e autorizado antes da ação destrutiva.
  • remember — Crie um novo registro duradouro somente quando ele for realmente necessário.
  • todos — Gerencie o estado da tarefa diretamente; use forget apenas para uma exclusão revisada.
  • ledger — Gerencie registros financeiros por meio do dispatcher governado do Ledger.

Origem: Controles do Memory Console