mixgram 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +11 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,11 +1,16 @@
1
1
  # Mixgram
2
2
 
3
- MCP memory server compatible with [Engram](https://github.com/gentleman-programming/engram): **Markdown as source of truth**, SQLite FTS5 for full-text search, and optional local embeddings.
3
+ MCP memory server compatible with [Engram](https://github.com/gentleman-programming/engram): **Markdown as source of truth**, SQLite FTS5 for full-text search. Optional local embeddings when you need hybrid search.
4
4
 
5
5
  - **Human-readable memory** — All durable memory is stored as Markdown files.
6
6
  - **Git-friendly** — Edit files by hand and reindex; the index is derived and rebuildable.
7
7
  - **Engram-compatible** — Same MCP tool names and semantics; drop-in replacement.
8
- - **Optional semantics** — Works fully with text-only; enable embeddings when you need hybrid search.
8
+
9
+ ### Advantages over Engram
10
+
11
+ - **Visible, editable docs** — As you advance with agentic development you see the actual documentation files on disk. You can open them, read them, and edit them manually; the agent’s memory is not hidden in a black box.
12
+ - **Versioned** — Memory lives in Markdown under your repo (e.g. `projects/<name>/memory/` or `home/memory/`). Commit, branch, and diff as with any other docs.
13
+ - **No semantic deps required** — Core experience is text-only (FTS5). No need to install embeddings or vector libs unless you opt in.
9
14
 
10
15
  ---
11
16
 
@@ -17,9 +22,7 @@ MCP memory server compatible with [Engram](https://github.com/gentleman-programm
17
22
  npm install -g mixgram
18
23
  ```
19
24
 
20
- Then use the `mixgram` command in your client config (see below).
21
-
22
- Embeddings (semantic search) are included; they are off by default. Turn them on via config or `mixgram mcp --embeddings`.
25
+ Then use the `mixgram` command in your client config (see below). No extra dependencies for core (text-only) memory; embeddings are optional.
23
26
 
24
27
  ---
25
28
 
@@ -51,7 +54,7 @@ Arguments are passed as `--key value`. Booleans use `--flag` or `--no-flag`. Arr
51
54
  | Option | Env | Description |
52
55
  |--------|-----|-------------|
53
56
  | `--config <path>` | `MIXGRAM_CONFIG` | Config file (default: `./.mixgram/config.json` or `~/.mixgram/config.json`). |
54
- | `--embeddings` | `MIXGRAM_EMBEDDINGS_ENABLED` | Enable semantic search. |
57
+ | `--embeddings` | `MIXGRAM_EMBEDDINGS_ENABLED` | Enable optional semantic (hybrid) search. |
55
58
  | `--watch` | `MIXGRAM_WATCH` | Watch files and reindex on change. |
56
59
  | `--home <path>` | `MIXGRAM_HOME` | Home memory root. |
57
60
  | `--projects <path>` | `MIXGRAM_PROJECTS` | Projects root. |
@@ -273,7 +276,7 @@ mem_search({ "query": "reindex", "scope_mode": "merged", "project": "my-app" })
273
276
 
274
277
  ## Optional semantic layer
275
278
 
276
- When `embeddings.enabled` is `true` and optional deps are installed:
279
+ When `embeddings.enabled` is `true` and the optional embedding stack is available:
277
280
 
278
281
  - **Saves** are durable and searchable by text immediately; embeddings are queued and processed in the background.
279
282
  - **Search** becomes **hybrid**: FTS + vector similarity, blended with `search.ftsWeight` and `search.semanticWeight` (e.g. 0.7 and 0.3).
@@ -281,7 +284,7 @@ When `embeddings.enabled` is `true` and optional deps are installed:
281
284
 
282
285
  ### Enable embeddings
283
286
 
284
- 1. Install optional deps: `npm install @huggingface/transformers sqlite-vec`
287
+ 1. Ensure optional deps are installed if your setup uses them (e.g. `@huggingface/transformers`, `sqlite-vec`).
285
288
  2. Configure:
286
289
 
287
290
  ```js
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mixgram",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "MCP memory server with Markdown source of truth and SQLite FTS5.",
5
5
  "keywords": [
6
6
  "mcp",