-
Notifications
You must be signed in to change notification settings - Fork 0
docs: align memory operations with current releases #363
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+186
−67
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Memory Operations Documentation Reconciliation | ||
|
|
||
| ## Scope | ||
|
|
||
| - Updated only `src/content/docs/docs/reference/api/memory-operations.md`. | ||
| - Added `tests/memory-operations-docs.test.mjs` as a focused static regression guard. | ||
|
|
||
| ## Source evidence | ||
|
|
||
| - AutoMem 0.16.2: `e147c352b100ebbf29e6555453fdde5152066138`, primarily `automem/api/memory.py` and `app.py`. | ||
| - MCP 0.16.0: `9a0bbf754dd31db524da25638b0e97907e32ff37`, primarily `src/mcp-surface.ts` and `src/automem-client.ts`. | ||
|
|
||
| ## Reconciled contracts | ||
|
|
||
| - Single `POST /memory` generates server UUIDs and documents its actual Qdrant values. | ||
| - Batch requests use `{ "memories": [...] }`, omit `id`, `embedding`, `t_valid`, and `t_invalid`, return 400 for malformed/empty/oversized input, and embed/upsert synchronously with queue fallback only for failures. | ||
| - PATCH accepts `updated_at` and `last_accessed`; a content change synchronously embeds and upserts. | ||
| - Tag enumeration is not ranked recall and does not hydrate relationships. | ||
| - MCP deletion supports XOR ID/bulk-tag modes with exact, case-insensitive tag matching; missing single IDs keep the HTTP 404. | ||
| - The global error envelope and tag examples use the current policy. | ||
|
|
||
| ## TDD and verification | ||
|
|
||
| - RED: `node --test tests/memory-operations-docs.test.mjs` failed all five new assertions against the stale page. | ||
| - GREEN: the focused test passes (5/5). | ||
| - `npm test`: 101 passed, 0 failed, 1 skipped (missing local CMS database). | ||
| - `npm run build`: passed. Existing Vite deprecation/chunk-size warnings remain non-blocking. | ||
| - `git diff --check`: passed. | ||
|
|
||
| ## Review round 1 | ||
|
|
||
| - Completed the batch Qdrant status set with the mixed `stored (N), queued (M)` result. | ||
| - Added pinned `app.py` and `src/memory-policy/shared.ts` source links, and verified every cited source link in the static test. | ||
| - Added a positive assertion that a missing single-delete ID preserves the HTTP 404 rather than being swallowed by MCP. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a future release changes
app.py,src/mcp-surface.ts, orsrc/memory-policy/shared.ts, the documentation-update workflow will not select this page:scripts/file-doc-map.jsonstill mapsapp.pyonly to overview/introduction and has no entries for either new MCP source, even though this source note now identifies all three as defining this page's contracts. Update the map alongside these citations so subsequent source-driven audits do not silently leave the page stale.AGENTS.md reference: AGENTS.md:L125-L129
Useful? React with 👍 / 👎.