@fingerskier/augment 0.1.0 → 0.1.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.
@@ -1 +1 @@
1
- {"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/mcp/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;QAC3B,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,OAAO;KACjB,CAAC,CAAC;IAEH,MAAM,CAAC,YAAY,CACjB,cAAc,EACd;QACE,WAAW,EAAE,0EAA0E;QACvF,WAAW,EAAE;YACX,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACpC;KACF,EACD,KAAK,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE;QACzB,MAAM,MAAM,GAAG,MAAM,oBAAoB,EAAE,CAAC;QAC5C,MAAM,QAAQ,GAAG,YAAY,IAAI,CAAC,MAAM,gBAAgB,EAAE,CAAC,CAAC;QAC5D,OAAO,UAAU,CAAC,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IAC1E,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,eAAe,EACf;QACE,WAAW,EAAE,8BAA8B;QAC3C,WAAW,EAAE;YACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAC5B;KACF,EACD,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CACxF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,QAAQ,EACR;QACE,WAAW,EAAE,wEAAwE;QACrF,WAAW,EAAE;YACX,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACnC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;YACjB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;YACrD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE;YAC7D,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE;YAC/C,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;SACvC;KACF,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;QACd,MAAM,MAAM,GAAG,MAAM,oBAAoB,EAAE,CAAC;QAC5C,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,CAAC,MAAM,gBAAgB,EAAE,CAAC,CAAC;QACtE,MAAM,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,EAAE,YAAY,EAAE,CAAC,CAAsB,CAAC;QACtF,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;SAClF,CAAC;IACJ,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,QAAQ,EACR;QACE,WAAW,EAAE,4DAA4D;QACzE,WAAW,EAAE;YACX,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;YACvC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;YACjD,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE;YACrC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;YAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;YACnB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;SACrC;KACF,EACD,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAChF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,MAAM,EACN;QACE,WAAW,EAAE,wDAAwD;QACrE,WAAW,EAAE;YACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;SAChC;KACF,EACD,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAC5E,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,MAAM,EACN;QACE,WAAW,EAAE,uDAAuD;QACpE,WAAW,EAAE;YACX,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;YAC3C,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;YACzC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE;SACpC;KACF,EACD,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAC9E,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,YAAY,EACZ;QACE,WAAW,EAAE,qDAAqD;QAClE,WAAW,EAAE;YACX,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;SACvC;KACF,EACD,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAC/F,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,QAAQ,EACR;QACE,WAAW,EAAE,iCAAiC;QAC9C,WAAW,EAAE;YACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;SAChC;KACF,EACD,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAC9E,CAAC;IAEF,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,oBAAoB,EAAE,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,UAAU,CAAC,KAAc;IAChC,MAAM,IAAI,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,MAAM,CAAE,KAA2B,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACzJ,OAAO;QACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,CAAC;KAC3C,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/mcp/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD,wFAAwF;AACxF,MAAM,CAAC,KAAK,UAAU,oBAAoB;IACxC,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;IAC/G,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IACpD,OAAQ,IAAI,CAAC,KAAK,CAAC,GAAG,CAAyB,CAAC,OAAO,CAAC;AAC1D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;QAC3B,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,MAAM,oBAAoB,EAAE;KACtC,CAAC,CAAC;IAEH,MAAM,CAAC,YAAY,CACjB,cAAc,EACd;QACE,WAAW,EAAE,0EAA0E;QACvF,WAAW,EAAE;YACX,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACpC;KACF,EACD,KAAK,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE;QACzB,MAAM,MAAM,GAAG,MAAM,oBAAoB,EAAE,CAAC;QAC5C,MAAM,QAAQ,GAAG,YAAY,IAAI,CAAC,MAAM,gBAAgB,EAAE,CAAC,CAAC;QAC5D,OAAO,UAAU,CAAC,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IAC1E,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,eAAe,EACf;QACE,WAAW,EAAE,8BAA8B;QAC3C,WAAW,EAAE;YACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAC5B;KACF,EACD,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CACxF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,QAAQ,EACR;QACE,WAAW,EAAE,wEAAwE;QACrF,WAAW,EAAE;YACX,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACnC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;YACjB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;YACrD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE;YAC7D,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE;YAC/C,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;SACvC;KACF,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;QACd,MAAM,MAAM,GAAG,MAAM,oBAAoB,EAAE,CAAC;QAC5C,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,CAAC,MAAM,gBAAgB,EAAE,CAAC,CAAC;QACtE,MAAM,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,EAAE,YAAY,EAAE,CAAC,CAAsB,CAAC;QACtF,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;SAClF,CAAC;IACJ,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,QAAQ,EACR;QACE,WAAW,EAAE,4DAA4D;QACzE,WAAW,EAAE;YACX,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;YACvC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;YACjD,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE;YACrC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;YAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;YACnB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;SACrC;KACF,EACD,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAChF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,MAAM,EACN;QACE,WAAW,EAAE,wDAAwD;QACrE,WAAW,EAAE;YACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;SAChC;KACF,EACD,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAC5E,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,MAAM,EACN;QACE,WAAW,EAAE,uDAAuD;QACpE,WAAW,EAAE;YACX,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;YAC3C,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;YACzC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE;SACpC;KACF,EACD,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAC9E,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,YAAY,EACZ;QACE,WAAW,EAAE,qDAAqD;QAClE,WAAW,EAAE;YACX,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;SACvC;KACF,EACD,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAC/F,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,QAAQ,EACR;QACE,WAAW,EAAE,iCAAiC;QAC9C,WAAW,EAAE;YACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;SAChC;KACF,EACD,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,oBAAoB,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAC9E,CAAC;IAEF,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,oBAAoB,EAAE,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,UAAU,CAAC,KAAc;IAChC,MAAM,IAAI,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,MAAM,CAAE,KAA2B,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACzJ,OAAO;QACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,CAAC;KAC3C,CAAC;AACJ,CAAC"}
package/docs/FEATURES.md CHANGED
@@ -1,245 +1,268 @@
1
- # Augment Features
2
-
3
- Augment is a local RAG memory system for coding agents.
4
-
5
- ## Memory Folder
6
-
7
- - The memory folder is a normal directory.
8
- - Only one memory root is configured per local system.
9
- - Memory file paths are relative to this root.
10
-
11
- ## Memories
12
-
13
- - Memories are text files in the memory folder.
14
- - Files are markdown with YAML frontmatter.
15
- - Canonical organization:
16
-
17
- ```txt
18
- org/repo/kind/name.md
19
- ```
20
-
21
- - Supported MVP kinds:
22
- - `ISSUE`
23
- - `ARCH`
24
- - `TODO`
25
- - `SPEC`
26
- - `WORK`
27
-
28
- Memory files are the canonical source of truth. Numeric memory IDs are local
29
- database IDs only and are not written to memory files. Relative paths are the
30
- durable cross-system identity.
31
-
32
- Example:
33
-
34
- ```md
35
- ---
36
- kind: ARCH
37
- project: fingerskier/augment
38
- name: search-contract
39
- tags: [mcp, search, ranking]
40
- links:
41
- - to: fingerskier/augment/SPEC/local-daemon.md
42
- type: RELATED
43
- created_at: 2026-06-29T00:00:00Z
44
- updated_at: 2026-06-29T00:00:00Z
45
- ---
46
-
47
- Body text.
48
- ```
49
-
50
- ## Database
51
-
52
- - A shared local daemon watches memory files and maintains a rebuildable libsql
53
- index.
54
- - The database includes metadata, body text, embeddings, gzip density score, and
55
- derived link rows.
56
- - `Xenova/bge-small-en-v1.5` via `@huggingface/transformers` provides 384D
57
- embeddings.
58
- - The database file is rebuildable and should not be synced as canonical state.
59
-
60
- Tables:
61
-
62
- - `projects`
63
- - `id`
64
- - `name`
65
- - `org`
66
- - `repo`
67
- - `source`
68
- - `memories`
69
- - `id`
70
- - `project_id`
71
- - `kind`
72
- - `name`
73
- - `relative_path`
74
- - `content_hash`
75
- - `frontmatter_hash`
76
- - `size`
77
- - `density`
78
- - `mtime`
79
- - `memory_embeddings`
80
- - `memory_id`
81
- - `model_id`
82
- - `model_version`
83
- - `dimensions`
84
- - `vector`
85
- - `embedded_hash`
86
- - `links`
87
- - `id`
88
- - `from_memory_id`
89
- - `to_memory_id`
90
- - `type`
91
-
92
- Links are written to the source memory's frontmatter using target relative paths.
93
- The daemon rebuilds local `links` rows from those declarations.
94
-
95
- ## Daemon
96
-
97
- - `augment-daemon` is shared by all local MCP servers for one memory root.
98
- - The daemon owns file watching, embedding, and database writes.
99
- - It exposes a localhost HTTP control endpoint.
100
- - It binds to `127.0.0.1`, uses a dynamic port by default, writes a discovery
101
- file, and requires a generated auth token for non-health requests.
102
-
103
- ## MCP Tools
104
-
105
- ### `init_project`
106
-
107
- Infers or accepts a project name and upserts a project record.
108
-
109
- Inputs:
110
-
111
- ```ts
112
- { project_name?: string }
113
- ```
114
-
115
- ### `list_projects`
116
-
117
- Lists known project records.
118
-
119
- Inputs:
120
-
121
- ```ts
122
- { name?: string }
123
- ```
124
-
125
- ### `search`
126
-
127
- Recalls memories semantically and lexically similar to a query.
128
-
129
- Inputs:
130
-
131
- ```ts
132
- {
133
- project_name?: string;
134
- query: string;
135
- limit?: number;
136
- max_chars?: number;
137
- kinds?: Array<"ISSUE" | "ARCH" | "TODO" | "SPEC" | "WORK">;
138
- include_linked?: boolean;
139
- }
140
- ```
141
-
142
- Behavior:
143
-
144
- - Returns plain text suitable for direct context injection.
145
- - Includes local memory IDs, project names, paths, kinds, scores, and link
146
- annotations.
147
- - May use the CWD project as a modest metadata boost, but cross-project results
148
- are allowed based on score.
149
- - Prioritizes linked memories without requiring them.
150
- - Does not summarize or extract arbitrary excerpts.
151
-
152
- ### `upsert`
153
-
154
- Stores text in a memory file.
155
-
156
- Inputs:
157
-
158
- ```ts
159
- {
160
- project_id: number;
161
- memory_id?: number;
162
- kind?: "ISSUE" | "ARCH" | "TODO" | "SPEC" | "WORK";
163
- name: string;
164
- content: string;
165
- tags?: string[];
166
- }
167
- ```
168
-
169
- If `memory_id` is absent, Augment may automatically update a highly similar
170
- memory in the same project and kind.
171
-
172
- ### `read`
173
-
174
- Reads one memory by local numeric ID.
175
-
176
- Inputs:
177
-
178
- ```ts
179
- { id: number }
180
- ```
181
-
182
- ### `link`
183
-
184
- Creates a directional link between local memory IDs and persists it as a
185
- relative-path link in the source memory frontmatter.
186
-
187
- Inputs:
188
-
189
- ```ts
190
- {
191
- from_memory_id: number;
192
- to_memory_id: number;
193
- type?: "DEPENDS_ON" | "BLOCKS" | "IMPLEMENTS" | "PARENT" | "RELATED";
194
- }
195
- ```
196
-
197
- ### `list_links`
198
-
199
- Lists inbound and outbound links involving a memory.
200
-
201
- Inputs:
202
-
203
- ```ts
204
- { memory_id: number }
205
- ```
206
-
207
- ### `unlink`
208
-
209
- Removes a link by local link ID.
210
-
211
- Inputs:
212
-
213
- ```ts
214
- { id: number }
215
- ```
216
-
217
- ## Configuration
218
-
219
- Resolution order:
220
-
221
- 1. Environment variables.
222
- 2. `~/.augment/config.json`.
223
- 3. Defaults.
224
-
225
- Environment variables:
226
-
227
- - `AUGMENT_MEMORY_ROOT`
228
- - `AUGMENT_STATE_DIR`
229
- - `AUGMENT_DAEMON_PORT`
230
-
231
- Defaults:
232
-
233
- - Memory root: `~/.augment/memories`
234
- - State directory: `~/.augment/state`
235
- - Database: `~/.augment/state/index.db`
236
- - Daemon discovery file: `~/.augment/state/daemon.json`
237
-
238
- ## Deferred
239
-
240
- - Dashboard.
241
- - `sleep`.
242
- - `dream`.
243
- - Remote sync.
244
- - Memory `move`.
245
- - CLI aliases and UX beyond diagnostics/config helpers.
1
+ # Augment Features
2
+
3
+ Augment is a local RAG memory system for coding agents.
4
+
5
+ ## Memory Folder
6
+
7
+ - The memory folder is a normal directory.
8
+ - Only one memory root is configured per local system.
9
+ - Memory file paths are relative to this root.
10
+
11
+ ## Memories
12
+
13
+ - Memories are text files in the memory folder.
14
+ - Files are markdown with YAML frontmatter.
15
+ - Canonical organization:
16
+
17
+ ```txt
18
+ org/repo/kind/name.md
19
+ ```
20
+
21
+ - Supported MVP kinds:
22
+ - `ISSUE`
23
+ - `ARCH`
24
+ - `TODO`
25
+ - `SPEC`
26
+ - `WORK`
27
+
28
+ Memory files are the canonical source of truth. Numeric memory IDs are local
29
+ database IDs only and are not written to memory files. Relative paths are the
30
+ durable cross-system identity.
31
+
32
+ Example:
33
+
34
+ ```md
35
+ ---
36
+ kind: ARCH
37
+ project: fingerskier/augment
38
+ name: search-contract
39
+ tags: [mcp, search, ranking]
40
+ links:
41
+ - to: fingerskier/augment/SPEC/local-daemon.md
42
+ type: RELATED
43
+ created_at: 2026-06-29T00:00:00Z
44
+ updated_at: 2026-06-29T00:00:00Z
45
+ ---
46
+
47
+ Body text.
48
+ ```
49
+
50
+ ## Database
51
+
52
+ - A shared local daemon watches memory files and maintains a rebuildable libsql
53
+ index.
54
+ - The database includes metadata, body text, embeddings, gzip density score, and
55
+ derived link rows.
56
+ - `Xenova/bge-small-en-v1.5` via `@huggingface/transformers` provides 384D
57
+ embeddings.
58
+ - The database file is rebuildable and should not be synced as canonical state.
59
+
60
+ Tables:
61
+
62
+ - `projects`
63
+ - `id`
64
+ - `name`
65
+ - `org`
66
+ - `repo`
67
+ - `source`
68
+ - `memories`
69
+ - `id`
70
+ - `project_id`
71
+ - `kind`
72
+ - `name`
73
+ - `relative_path`
74
+ - `content_hash`
75
+ - `frontmatter_hash`
76
+ - `size`
77
+ - `density`
78
+ - `mtime`
79
+ - `memory_embeddings`
80
+ - `memory_id`
81
+ - `model_id`
82
+ - `model_version`
83
+ - `dimensions`
84
+ - `vector`
85
+ - `embedded_hash`
86
+ - `links`
87
+ - `id`
88
+ - `from_memory_id`
89
+ - `to_memory_id`
90
+ - `type`
91
+
92
+ Links are written to the source memory's frontmatter using target relative paths.
93
+ The daemon rebuilds local `links` rows from those declarations.
94
+
95
+ ## Daemon
96
+
97
+ - `augment-daemon` is shared by all local MCP servers for one memory root.
98
+ - The daemon owns file watching, embedding, and database writes.
99
+ - It exposes a localhost HTTP control endpoint.
100
+ - It binds to `127.0.0.1`, uses a dynamic port by default, writes a discovery
101
+ file, and requires a generated auth token for non-health requests.
102
+
103
+ ## MCP Tools
104
+
105
+ ### `init_project`
106
+
107
+ Infers or accepts a project name and upserts a project record.
108
+
109
+ Inputs:
110
+
111
+ ```ts
112
+ { project_name?: string }
113
+ ```
114
+
115
+ ### `list_projects`
116
+
117
+ Lists known project records.
118
+
119
+ Inputs:
120
+
121
+ ```ts
122
+ { name?: string }
123
+ ```
124
+
125
+ ### `search`
126
+
127
+ Recalls memories semantically and lexically similar to a query.
128
+
129
+ Inputs:
130
+
131
+ ```ts
132
+ {
133
+ project_name?: string;
134
+ query: string;
135
+ limit?: number;
136
+ max_chars?: number;
137
+ kinds?: Array<"ISSUE" | "ARCH" | "TODO" | "SPEC" | "WORK">;
138
+ include_linked?: boolean;
139
+ }
140
+ ```
141
+
142
+ Behavior:
143
+
144
+ - Returns plain text suitable for direct context injection.
145
+ - Includes local memory IDs, project names, paths, kinds, scores, and link
146
+ annotations.
147
+ - May use the CWD project as a modest metadata boost, but cross-project results
148
+ are allowed based on score.
149
+ - Prioritizes linked memories without requiring them.
150
+ - Does not summarize or extract arbitrary excerpts.
151
+
152
+ ### `upsert`
153
+
154
+ Stores text in a memory file.
155
+
156
+ Inputs:
157
+
158
+ ```ts
159
+ {
160
+ project_id: number;
161
+ memory_id?: number;
162
+ kind?: "ISSUE" | "ARCH" | "TODO" | "SPEC" | "WORK";
163
+ name: string;
164
+ content: string;
165
+ tags?: string[];
166
+ }
167
+ ```
168
+
169
+ If `memory_id` is absent, Augment may automatically update a highly similar
170
+ memory in the same project and kind.
171
+
172
+ ### `read`
173
+
174
+ Reads one memory by local numeric ID.
175
+
176
+ Inputs:
177
+
178
+ ```ts
179
+ { id: number }
180
+ ```
181
+
182
+ ### `link`
183
+
184
+ Creates a directional link between local memory IDs and persists it as a
185
+ relative-path link in the source memory frontmatter.
186
+
187
+ Inputs:
188
+
189
+ ```ts
190
+ {
191
+ from_memory_id: number;
192
+ to_memory_id: number;
193
+ type?: "DEPENDS_ON" | "BLOCKS" | "IMPLEMENTS" | "PARENT" | "RELATED";
194
+ }
195
+ ```
196
+
197
+ ### `list_links`
198
+
199
+ Lists inbound and outbound links involving a memory.
200
+
201
+ Inputs:
202
+
203
+ ```ts
204
+ { memory_id: number }
205
+ ```
206
+
207
+ ### `unlink`
208
+
209
+ Removes a link by local link ID.
210
+
211
+ Inputs:
212
+
213
+ ```ts
214
+ { id: number }
215
+ ```
216
+
217
+ ## Configuration
218
+
219
+ Resolution order:
220
+
221
+ 1. Environment variables.
222
+ 2. `~/.augment/config.json`.
223
+ 3. Defaults.
224
+
225
+ Environment variables:
226
+
227
+ - `AUGMENT_MEMORY_ROOT`
228
+ - `AUGMENT_STATE_DIR`
229
+ - `AUGMENT_DAEMON_PORT`
230
+
231
+ Defaults:
232
+
233
+ - Memory root: `~/.augment/memories`
234
+ - State directory: `~/.augment/state`
235
+ - Database: `~/.augment/state/index.db`
236
+ - Daemon discovery file: `~/.augment/state/daemon.json`
237
+
238
+ ## Agent Integration Installer
239
+
240
+ The `augment` CLI can install dogfooding integrations:
241
+
242
+ ```powershell
243
+ npm exec --yes --package @fingerskier/augment -- augment install codex --scope user --memory-root "C:\Users\you\Dropbox\augment-memories"
244
+ npm exec --yes --package @fingerskier/augment -- augment install codex --scope repo
245
+ npm exec --yes --package @fingerskier/augment -- augment install claude --scope repo
246
+ npm exec --yes --package @fingerskier/augment -- augment install all --scope user --dry-run
247
+ ```
248
+
249
+ Codex install creates or updates:
250
+
251
+ - A local plugin folder named `augment`.
252
+ - `.codex-plugin/plugin.json`.
253
+ - `.mcp.json` pointing to the published `@fingerskier/augment` package through
254
+ an isolated npm `--prefix` directory.
255
+ - `skills/augment-context/SKILL.md`.
256
+ - A personal or repo marketplace entry.
257
+
258
+ Claude install creates or updates a marked Augment block in `CLAUDE.md` with the
259
+ same cwd-safe MCP command shape.
260
+
261
+ ## Deferred
262
+
263
+ - Dashboard.
264
+ - `sleep`.
265
+ - `dream`.
266
+ - Remote sync.
267
+ - Memory `move`.
268
+ - CLI aliases and UX beyond diagnostics/config helpers.
@@ -1,28 +1,56 @@
1
- # Augment Memory Workflow
2
-
3
- When the Augment MCP server is configured, use it as the local project memory.
4
-
5
- Session start:
6
- - Call `init_project`.
7
- - Call `search` with the user's task summary.
8
-
9
- Before implementation:
10
- - Search for the specific file, subsystem, behavior, or error.
11
- - Read exact memories by ID when search results point to important context.
12
-
13
- During and after work:
14
-
15
- - Use `upsert` for durable notes:
16
- - `SPEC` for requirements and contracts.
17
- - `ARCH` for decisions and design rationale.
18
- - `TODO` for future work.
19
- - `ISSUE` for bugs, risks, and blockers.
20
- - `WORK` for concise implementation notes.
21
- - Use `link` when one memory depends on, implements, blocks, parents, or relates to another.
22
- - At completion, write a short `WORK` memory with the outcome and verification.
23
-
24
- Rules:
25
- - Do not store secrets or credentials.
26
- - Do not store large logs, generated files, dependency dumps, or full source files.
27
- - Keep memories small and focused.
28
- - Numeric memory IDs are local to the machine. Relative paths are durable across systems.
1
+ # Augment Memory Workflow
2
+
3
+ When the Augment MCP server is configured, use it as the local project memory.
4
+
5
+ ## Session Start
6
+
7
+ - Call `init_project`.
8
+ - Call `search` with the user's task summary.
9
+ - Read exact memories when search results identify governing context.
10
+
11
+ ## Before Implementation
12
+
13
+ - Search for the specific file, subsystem, behavior, command, or error.
14
+ - If the work depends on a prior decision, read and follow the relevant `SPEC`
15
+ or `ARCH` memory.
16
+ - If no relevant memory exists but the task creates a durable requirement or
17
+ decision, create one before implementation.
18
+
19
+ ## Memory Triggers
20
+
21
+ Call `upsert` whenever one of these durable events happens:
22
+
23
+ - A requirement, API contract, data model, or tool contract is clarified:
24
+ use `SPEC`.
25
+ - An implementation approach, tradeoff, transport choice, persistence model, or
26
+ architecture decision is made: use `ARCH`.
27
+ - A bug, risk, failing behavior, or blocker is discovered: use `ISSUE`.
28
+ - Follow-up work is intentionally deferred: use `TODO`.
29
+ - A meaningful implementation milestone is completed: use `WORK`.
30
+ - A test scenario, regression case, or verification rule is learned: use `SPEC`
31
+ or `WORK`, whichever is more durable.
32
+
33
+ ## Links
34
+
35
+ After creating or updating a memory:
36
+
37
+ - Use `link` when one memory depends on, implements, blocks, parents, or relates
38
+ to another.
39
+ - Prefer linking new `WORK` notes to the `SPEC`, `ARCH`, `ISSUE`, or `TODO` they
40
+ address.
41
+
42
+ ## Completion
43
+
44
+ - Upsert a concise `WORK` memory with what changed, key files, and verification.
45
+ - Upsert or update `TODO` memories for known remaining work.
46
+ - Link the final `WORK` memory to the relevant planning/decision memories.
47
+
48
+ ## Rules
49
+
50
+ - Do not store secrets, credentials, tokens, or private keys.
51
+ - Do not store large logs, generated files, dependency dumps, or full source files.
52
+ - Keep memories small and focused.
53
+ - Use returned search text directly as context; do not ask Augment to summarize.
54
+ - Numeric memory IDs are local to the machine. Relative paths are durable across systems.
55
+ - Do not create memories for trivial edits, transient exploration, or facts that
56
+ are already obvious from the current diff.