memory: README does not say that unreadable lines are skipped, kept on every write, and fixable only by hand
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 90/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- typescript
- Domain
- documentation
Research direction
Read src/memory/README.md alongside loadGraphWithUnreadable and saveGraph in src/memory/index.ts to confirm the documented behavior. Add a short passage near storage or troubleshooting covering skipped and logged lines, preservation on writes and byte limits, tool limitations, and manual repair. Done when the README explains the stated behavior and recovery steps.
Written by the indexing model from the issue text.
Description
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 noentityType, an observation that is not a string, a relation with norelationType) 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_nodesandopen_nodesdo not show it;delete_entitiesanddelete_observationsreport its name as not found;add_observationsandcreate_relationsfail with "Entity with name … not found";create_entitiesunder the same name stores a second record beside the invalid line; an invalid relation matches nodelete_relationscall and stays after the entities it names are deleted. #5541 pins this insrc/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.
- Dominant language
- TypeScript
- Stars
- 92k
- Forks
- 12k
- Avg merge
- 3h 46m
- Merged PRs (30d)
- 206
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from modelcontextprotocol/servers
-
`interface-diff` discards the git error when resolving its default base and reports the wrong causeOpen
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
modelcontextprotocol/servers#5636 ·
Maintainers usually reply within 1 day
-
chore server-memory v2
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
modelcontextprotocol/servers#5634 ·
Maintainers usually reply within 1 day
-
bug server-memory v2
Difficulty 4/5 3-5 days Newbie friendliness 48/100
modelcontextprotocol/servers#5635 · 1 comment ·
Maintainers usually reply within 1 day
-
bug server-memory v2
Difficulty 5/5 Over a week Newbie friendliness 42/100
modelcontextprotocol/servers#5624 ·
Maintainers usually reply within 1 day
-
enhancement v2
Difficulty 4/5 3-5 days Newbie friendliness 48/100
modelcontextprotocol/servers#5611 ·
Maintainers usually reply within 1 day
All issues in modelcontextprotocol/servers
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
hurttlocker/o8#6535 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 1 day
-
area: backend bug priority: low
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
snapotter-hq/SnapOtter#4856 ·
Maintainers usually reply within 1 day
-
bug follow-up
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
spellshift/realm#2509 ·
Maintainers usually reply within 1 day