docs: refresh README (automated audit)#1
Open
rustyorb wants to merge 1 commit into
Open
Conversation
Reviewer's GuideAdds a new top-level README that documents the antigravity-memory MCP server, including its features, tech stack, structure, setup, configuration, usage, and relationship to existing nested documentation files. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
Adds a new top-level README.md intended to provide a purely technical, verifiable overview of the antigravity-memory MCP server (features, setup, configuration, and tool/resource surface) distinct from the more narrative docs under antigravity-memory/.
Changes:
- Introduces a top-level README documenting the MCP server’s capabilities (encrypted graph memory, tools/resources, migration behavior).
- Documents local install/run steps and an example MCP client configuration snippet.
- Adds a “Note on Content” clarifying the distinction between narrative subproject docs and this README.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **Graph traversal ("reflect")** — beyond direct text matches, follows edges to surface connected memories for a topic. | ||
| - **Non-destructive evolution** — updating a memory (`evolve`) preserves the prior content and the reason for the change instead of overwriting it. | ||
| - **Deprecation instead of deletion** — `forget` hides a memory from normal recall but keeps it in the graph with a documented reason. | ||
| - **Automatic migration** — on startup, any legacy plaintext `nodes.json`/`edges.json` files are read, re-saved as encrypted, and removed. |
| - **Graph-structured memory** — every memory is a node (`entity`, `episode`, `knowledge`, `procedure`, or `reflection`); nodes are linked by typed edges (`relates_to`, `derived_from`, `contradicts`, `evolved_into`, `belongs_to`, `informed_by`). | ||
| - **Encrypted at rest** — memory nodes and edges are stored as AES-256-GCM ciphertext (`memory/nodes.enc`, `memory/edges.enc`); a 256-bit key is auto-generated on first run and saved to `memory/.key`. | ||
| - **Salience-ranked recall** — text/type/tag search over memories, sorted by salience then recency, with access-count tracking. | ||
| - **Graph traversal ("reflect")** — beyond direct text matches, follows edges to surface connected memories for a topic. |
| - **Encrypted at rest** — memory nodes and edges are stored as AES-256-GCM ciphertext (`memory/nodes.enc`, `memory/edges.enc`); a 256-bit key is auto-generated on first run and saved to `memory/.key`. | ||
| - **Salience-ranked recall** — text/type/tag search over memories, sorted by salience then recency, with access-count tracking. | ||
| - **Graph traversal ("reflect")** — beyond direct text matches, follows edges to surface connected memories for a topic. | ||
| - **Non-destructive evolution** — updating a memory (`evolve`) preserves the prior content and the reason for the change instead of overwriting it. |
Comment on lines
+69
to
+70
| `memory/.key` is required to decrypt existing memories — back it up if the data matters, and never commit it (it's already listed in `.gitignore`). | ||
|
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Automated README audit — please review the proposed README before merging.
Generated by [repo-readme-auditor].
Summary by Sourcery
Add a top-level README describing the antigravity-memory MCP server, its capabilities, setup, and usage.
Documentation: