@cuylabs/agent-memory-filesystem 5.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,366 @@
+# Agent Memory Filesystem
+
+Filesystem-backed memory provider for `@cuylabs/agent-core`.
+
+The package is organized by implementation area:
+
+```text
+src/
+  provider.ts       # provider surface for agent-core
+  settings.ts       # provider options and public filesystem memory types
+  capture.ts        # connects agent-core capture hooks to provider-owned extraction
+  agents/
+    capture.ts      # optional private memory writer built on agent-core
+    recall.ts       # optional private read-only memory recall worker
+  storage/
+    io.ts           # low-level file reads and directory traversal
+    reader.ts       # turns durable record files into records
+    store.ts        # file I/O and writable record operations
+    records.ts      # record IDs and serialization
+    paths.ts        # path defaults and resolution
+  tools/
+    memory-tools.ts # foreground memory tools installed by the provider
+  search/
+    filesystem.ts # line-aware filesystem search and ranking
+    tokenizer.ts # query and record tokenization
+```
+
+The provider is intentionally filesystem-specific. The generic boundary lives
+in `@cuylabs/agent-core`; sibling packages can implement the same provider
+contract for graph, vector, or service-backed memory without sharing this
+package's storage code.
+
+```typescript
+import { createAgent } from "@cuylabs/agent-core";
+import { createFilesystemMemoryProvider } from "@cuylabs/agent-memory-filesystem";
+
+const agent = createAgent({
+  model,
+  memory: createFilesystemMemoryProvider({ root: ".agent-memory" }),
+});
+```
+
+Memory remains opt-in. `@cuylabs/agent-core` owns the provider contract and
+lifecycle wiring; this package owns concrete provider adapters. There is no
+YAML discovery layer in the default path: applications import a provider
+factory, pass provider-specific options, and give the resulting provider to
+`createAgent({ memory })`.
+
+The filesystem provider uses line-aware local file search underneath its memory
+tools and private recall worker. When automatic recall is configured,
+agent-core calls `provider.recall(...)` once per user turn by default, using the
+latest user message as the recall task, then reuses that result across
+tool-loop steps. The provider searches durable `records/*.md` files. Search
+results include bounded snippets with source path and line metadata, so the
+recall worker can inspect the exact file location instead of receiving a whole
+memory file blindly.
+
+For `memory_search`, the query is primary: the provider scans visible record
+content and metadata, then ranks matching snippets. Tags are only ranking hints
+for search because model-guessed tags should not hide content matches. For
+`memory_list`, tags remain exact filters because list is an explicit inventory
+operation.
+
+There is no database, vector service, or hardcoded stop-word policy in the
+default path. Callers can provide a custom tokenizer, explicit stop words,
+snippet sizing, or a different search engine through
+`createFilesystemMemoryProvider({ recall: ... })` when the default lexical
+ranking is not enough.
+
+Automatic recall is agentic-only. Configure `recall.agent` with a private recall
+worker model. Agent-core still calls `provider.recall(...)`; the filesystem
+provider owns the worker and only gives it read-only memory tools such as
+`memory_search`, `memory_get`, and `memory_list`.
+
+```typescript
+const memory = createFilesystemMemoryProvider({
+  root: ".agent-memory",
+  recall: {
+    agent: {
+      model: memoryModel,
+      maxSteps: 4,
+      timeoutMs: 10_000,
+    },
+  },
+});
+```
+
+The intended model-based flow is:
+
+```text
+agent-core before LLM call
+  -> provider.recall()
+    -> filesystem recall agent
+      -> memory_search returns ranked file snippets with line ranges
+      -> memory_get reads an exact memory record when needed
+      -> recall agent returns one compact summary
+  -> core injects that summary
+  -> main agent LLM call
+```
+
+When no recall agent is configured, the provider does not install automatic
+recall. The foreground agent can still use provider-owned `memory_search`,
+`memory_get`, and `memory_list` tools, and application code can still call
+`provider.search(...)` directly.
+
+The default on-disk layout is:
+
+```text
+.agent-memory/
+  records/
+    2026-05-14-package-manager-a1b2c3d4.md
+```
+
+`records/` is the canonical durable memory corpus. Raw conversation history
+belongs to `SessionStore` implementations such as
+`@cuylabs/agent-session-store-file`, not to the memory provider. The provider
+does not read or generate root-level `MEMORY.md`, `memory_summary.md`,
+`index.json`, or journal files in the default path. If those become first-class
+artifacts later, they should be added as explicit provider-owned components
+instead of implicit side files.
+
+Each record is Markdown with JSON frontmatter:
+
+```markdown
+---
+{
+  "id": "2026-05-15-release-plan-a1b2c3d4",
+  "title": "Release plan",
+  "kind": "fact",
+  "scope": "project",
+  "tags": ["release"],
+  "metadata": {
+    "sessionId": "s1",
+    "memoryKey": "release-plan"
+  }
+}
+---
+
+The release codename is copper.
+```
+
+The JSON block is intentionally not YAML. It is still a frontmatter block, but
+the provider can parse it with the platform JSON parser, avoid adding a YAML
+dependency, and scan only the header when it later needs metadata-first
+operations. The Markdown body remains the searchable memory text.
+
+## Memory vs Sessions
+
+`@cuylabs/agent-core` sessions and this provider's memory files are separate
+layers:
+
+| Layer | Package | Default durable shape | Purpose |
+| --- | --- | --- | --- |
+| Raw chat history | `@cuylabs/agent-core/sessions` plus a `SessionStore` | Store-specific, for example `<session-id>.jsonl` in `@cuylabs/agent-session-store-file` | Reconstruct conversation messages, branches, and compaction entries. |
+| Durable memory | `@cuylabs/agent-memory-filesystem` | `.agent-memory/records/*.md` | Searchable facts, preferences, summaries, and lessons that should survive beyond the current prompt window. |
+
+Normal turn capture and compaction-commit capture both write durable memory by
+calling the provider's `remember` path. That path creates, updates, or skips one
+canonical `records/*.md` file. Record metadata includes the originating
+`sessionId`, optional `turnId`, source hook, tags, scope, and provider-managed
+dedupe metadata.
+
+Records do not need to be split into per-session folders. Isolation is handled
+by record scope:
+
+- `session` records are only recalled when the current `sessionId` matches the
+  metadata on the record.
+- `project` records are recalled across sessions in the same memory root.
+- `user` and `global` are available for providers that want broader sharing.
+
+By default, filesystem memory writes use `project` scope because durable memory
+is usually meant to help future sessions in the same project. Set
+`defaultScope: "session"` or have your capture worker/tool call pass
+`scope: "session"` when a memory should stay private to one chat session.
+
+## Pluggability model
+
+The public integration point is the provider factory:
+
+```typescript
+const memory = createFilesystemMemoryProvider({
+  root: ".agent-memory",
+  defaultScope: "session", // omit this for project-wide memory by default
+  recall: {
+    tokenizer: customTokenizer,
+    engine: customSearchEngine,
+  },
+  remember: {
+    captureTurn: customTurnExtractor,
+  },
+});
+```
+
+That keeps the hookup simple while still allowing the implementation to get
+more powerful. Recall, storage, and remembering can evolve behind the provider
+boundary without changing application code.
+
+## Memory Capture
+
+`agent-core` calls provider capture hooks when memory capture is enabled with
+`memory.capture`. This package keeps the low-level core hook names internal and
+exposes `remember.captureTurn` and `remember.captureBeforeCompactionCommit` as the
+memory-facing options. `src/capture.ts` adapts core lifecycle input to the
+remember pipeline.
+
+The default provider does not silently write every conversation turn into
+durable memory. Turn-end writes are enabled by passing a provider-owned
+extractor:
+
+```typescript
+const memory = createFilesystemMemoryProvider({
+  root: ".agent-memory",
+  remember: {
+    async captureTurn({ input, output }) {
+      if (!output) return [];
+      if (!input.includes("remember")) return [];
+
+      return {
+        title: "User preference",
+        content: output,
+        kind: "turn-capture",
+        scope: "project",
+        tags: ["preference"],
+      };
+    },
+  },
+});
+```
+
+That extractor receives the full `AgentMemoryTurnEndInput` from core and
+returns memory drafts. The file provider stores those drafts as normal records
+with `source: "turn_capture"`, so recall and `memory_search` can find them on later
+turns. If `memory.capture` is disabled in `createAgent({ memory: { ... } })`,
+core does not call turn-start or turn-end capture hooks.
+
+Compaction-commit capture is separate from turn capture. When a provider
+implements `remember.captureBeforeCompactionCommit`, agent-core awaits it after
+the cut and summary are prepared, before the compacted history is committed. Use
+it for last-chance durable extraction from context that is about to be
+compacted. Omit `remember.captureBeforeCompactionCommit` to disable this path:
+
+```typescript
+const memory = createFilesystemMemoryProvider({
+  root: ".agent-memory",
+  remember: {
+    async captureBeforeCompactionCommit({ removedMessages, nextSummary }) {
+      if (removedMessages.length === 0) return [];
+
+      return {
+        title: "Compacted conversation facts",
+        content:
+          nextSummary ?? removedMessages.map((m) => String(m.content)).join("\n"),
+        kind: "compaction-capture",
+        scope: "project",
+      };
+    },
+  },
+});
+```
+
+The provider decides whether `captureTurn` and `captureBeforeCompactionCommit` are
+deterministic functions, calls to a smaller extraction model, or wrappers around
+another service. From core's perspective they are provider-owned memory writes,
+not a replacement for the compaction algorithm.
+
+The filesystem store enforces a conservative dedupe policy after the extractor
+or private writer proposes a record:
+
+- exact duplicate content in the same visible scope is skipped and returns the
+  existing record id;
+- `memoryKey` can target an existing logical memory, including an existing
+  record id;
+- `onExisting: "append"` adds new content to that keyed record;
+- `onExisting: "replace"` rewrites the keyed record's body;
+- fuzzy "related" memories are not merged automatically because semantic merge
+  can accidentally combine contradictory facts.
+
+Use keyed append for deliberate incremental records:
+
+```typescript
+await memory.remember?.({
+  sessionId,
+  cwd,
+  title: "Release plan",
+  content: "The release codename is copper.",
+  scope: "project",
+  memoryKey: "release-plan",
+});
+
+await memory.remember?.({
+  sessionId,
+  cwd,
+  title: "Release plan",
+  content: "The launch window is June.",
+  scope: "project",
+  memoryKey: "release-plan",
+  onExisting: "append",
+});
+```
+
+For model-based extraction, use the agentic helper. It creates a private
+`agent-core` worker with an isolated in-memory session and a narrow memory tool
+set bound to the file provider. The tool names intentionally match the
+`AgentMemoryProvider` read/write contract used by foreground memory tools:
+
+- `memory_search` calls provider search for related durable memory.
+- `memory_get` reads one exact durable memory record by id.
+- `memory_list` calls provider list, or the provider's search fallback, for a
+  filtered inventory.
+- `memory_remember` writes one durable memory through the provider's normal
+  `remember` pipeline. It can pass a `memoryKey` plus `onExisting: "append"`
+  when extending an existing record found through search/list.
+
+The normal workflow is: search/list existing memory, remember only new durable
+facts, use keyed append for explicit incremental updates, then return
+`NO_REPLY`. The store still verifies the write, so exact duplicate content is
+skipped even if the private worker misses it. The worker never receives generic
+file read/write tools, `memory_forget`, or the foreground agent's full tool set.
+Automatic `recall` is still triggered by core through `provider.recall(...)`;
+when agentic recall is configured, the provider implements that hook with its
+own private read-only worker.
+
+A profile carries the model, prompt, tool filters, and step limits in the same
+shape used by subagents.
+
+```typescript
+import {
+  createAgenticMemoryCapture,
+  createFilesystemMemoryProvider,
+} from "@cuylabs/agent-memory-filesystem";
+
+const memory = createFilesystemMemoryProvider({
+  root: ".agent-memory",
+  remember: {
+    captureBeforeCompactionCommit: createAgenticMemoryCapture({
+      model: memoryModel,
+      profile: memoryCaptureProfile,
+      maxSteps: 4,
+      timeoutMs: 15_000,
+    }),
+  },
+});
+```
+
+That worker is provider-owned host policy. It is not exposed as a foreground
+tool, and agent-core still awaits `captureBeforeCompactionCommit` before
+committing the compacted session history.
+Pass any additional read helpers through `tools`, and apply the private
+worker's own `middleware`, `approval`, or `toolExecutionMode` policy there. The
+memory worker should not inherit the foreground agent's full tool set.
+
+No SQL database is required for the default provider. Search is built
+in-process from local files on each call, with exact/snippet matching and
+lexical ranking over Markdown memory files. A SQLite FTS or vector backend
+should be added behind the same recall/provider boundary when memory size or
+latency requires a persistent index.
+
+See [examples/README.md](./examples/README.md) for runnable local examples.
+After building `@cuylabs/agent-core` and this package, run them with:
+
+```sh
+pnpm run example:basic
+pnpm run example:records
+pnpm run example:agentic
+pnpm run example:automatic-recall
+```