memory: README does not say that unreadable lines are skipped, kept on every write, and fixable only by hand

Aperta Adatta ai principianti
#5,609 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
90/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Leggi src/memory/README.md insieme a loadGraphWithUnreadable e saveGraph in src/memory/index.ts per confermare il comportamento documentato. Aggiungi un breve passaggio vicino alla sezione sull’archiviazione o sulla risoluzione dei problemi che tratti le righe ignorate e registrate, la conservazione durante le scritture e i limiti in byte, le limitazioni dello strumento e la riparazione manuale. Il lavoro è completato quando il README spiega il comportamento descritto e i passaggi di ripristino.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation server-memory v2
Which server?

memory (@modelcontextprotocol/server-memory), src/memory/README.md.

The problem

The README does not say what the server does with a line of the memory file it cannot read, or how to fix one. The only mention is in passing, under the write limits ("MEMORY_MAX_FILE_BYTES counts the bytes of the file as it would be saved, unreadable lines included").

What the server does today (loadGraphWithUnreadable and saveGraph in src/memory/index.ts, from #4885):

  • A line that is not JSON, is not an object, has an unknown type, or fails the entity or relation schema (an entity with no entityType, an observation that is not a string, a relation with no relationType) is left out of the graph. Each skipped line is logged to stderr ("Skipping invalid entity in memory file: …").
  • Every save writes those lines back unchanged, after the graph's own lines, so a write never drops data it could not read.
  • No tool can then remove or repair such a line. read_graph, search_nodes and open_nodes do not show it; delete_entities and delete_observations report its name as not found; add_observations and create_relations fail with "Entity with name … not found"; create_entities under the same name stores a second record beside the invalid line; an invalid relation matches no delete_relations call and stays after the entities it names are deleted. #5541 pins this in src/memory/__tests__/invalid-record-removal.test.ts.

So the only remedy is to edit the file by hand, and a user who sees the stderr line, or a Not found for an entity they can see in the file, has nowhere to read that.

Expected

A short passage in the README (near the storage or troubleshooting sections) stating: which lines are skipped, that they are logged to stderr, that they are kept in the file on every write and count toward MEMORY_MAX_FILE_BYTES, that no tool reaches them, and that the fix is to stop the clients using the file and correct or delete the line in a text editor.

Scope

Documentation only. Whether a remediation tool should exist is a separate question this issue does not ask.

Found while verifying #5541.

Lingua principale
TypeScript
Stelle
92k
Fork
12k
Merge medio
3h 46m
PR unite (30g)
206

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di modelcontextprotocol/servers

Tutte le issue di modelcontextprotocol/servers

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.