dsh-memory-md
纯本地 Markdown 记忆插件(DSH)。助手通过 memory_md_* 工具把值得长期保留的内容写进 ~/.dsh/memory-md/,跨会话记住你。
记忆索引会在回合开始时作为上下文快照注入,所以助手不必先调工具就知道有什么记忆。
一、设计要点
1. 注入分两段:不变协议进提示词,易变索引进快照
记忆文本按生命周期分两类,走不同通道:
| 内容 | 通道 | 为什么 | |
|---|---|---|---|
| 协议 | 索引是什么、条目什么特征、边界在哪 | systemPrompt.section()(系统提示词) |
常量,逐字节恒定 → 前缀 KV Cache 始终命中 |
| 索引 | 用户级 + 项目级 MEMORY.md |
systemPrompt.context()(上下文快照) |
读盘、随记忆变化 → 不吃提示词前缀 |
关键约束:DSH 每个 step 都重新装配系统提示词(dsh-agent-loop 的 systemPrompt.assemble())。任何读盘的 prompt section 都会让提示词随文件变化,整个前缀的 KV Cache 随之失效。所以只有常量才允许进 section。
// 协议:静态文本,写死在提示词里
ctx.systemPrompt.section({ name: 'memory-md:protocol', order: 950, text: () => MEMORY_PROTOCOL })
// 索引:每次装配重读;空串则不贡献
ctx.systemPrompt.context({
name: 'memory-md:index',
order: 10_000,
text: () => renderMemoryIndex(...),
})
早先把两段都放进 context():协议文本于是在每次记忆变化时跟着重发一遍,而旧快照仍留在历史里(快照是追加而非替换),纯属浪费 token。拆开后,系统提示词里只有一份协议,快照里只有索引。
去重是白拿的。 dsh-agent-loop 的 RuntimeContextProjection.project() 会比对上一次保留的快照文本,内容未变则不产生任何消息 —— 所以「索引变了才注入、没变就不重复注入」由 loop 负责,插件不需要自己做跳过机制。
索引带确定性标签。 每份索引用 <memory-index scope="global|project" cwd="…"> 裹住,模型不必靠上下文猜这段文本的边界和作用域:
<memory-index scope="global">
- [用户偏好](memory/user_x.md) — 用中文回复
</memory-index>
注入的只有索引,不含分类文件全文;模型命中描述后自行读原文。
⚠️ 注入内容会被官方二次处理,{{...}} 必须先中和。 官方 interpolate() 把注入文本里的
{{name}} 当作提示词变量严格校验(变量名须匹配 /^[a-z][a-z0-9_]*$/),且对
context() 和 section() 都生效。所以记忆描述里只要出现 {{挖空}}、{{.Server.Version}}
这类合法模板语法,就会在 systemPrompt.assemble() 里抛错 —— 整个回合失败,
而且每轮都失败、永久锁死该工作区(agent 无法自救,只能手工改 MEMORY.md)。
修法是在注入边界做相邻花括号转义({{ → {\{,任意长度连续花括号都处理),
语义不变、原文可还原。inject 套件有回归断言,另有一条防未来断言:
协议段那个常量里不允许出现 {{。
2. 轮末总结在后台异步跑,不打扰对话
早先的实现挂在 agent/turn-stopping,往主对话 inbox.append('next-step') 塞一条 "Before this turn closes…" 的提醒。两个问题:它显示在对话里,而且逼主模型再跑一步。
现在改成:轮末起一次独立的、无工具的 LLM 调用(ctx.llm.stream()),由它总结做了什么、有什么值得沉淀,然后插件自己写记忆文件和日志文件。主对话全程不参与、不显示任何东西。
为什么不用子代理:ctx.subagents.start() 会创建真正的子 agent(有自己的 session、进会话列表、能调工具),还会再次触发 agent/turn-stopping —— 递归风险。这里只需要一次模型调用。
总结范围是「上次成功总结之后」,不是「本轮」。 每个会话维护一个游标,只在成功后推进。回合崩了、内容不足、调用失败时游标原地不动,下一轮自动补上。
这条是踩坑换来的:早先只取最后一个
turn/start起的事件,于是任何"没写成"的回合内容永久丢失。 真实事故:20 分钟的源码研究与实测,日志里一个字都没有(turn 以 error 结束 + 另一轮太短, 两者的工作就此出局,后面的回合用切片也看不到)。连续失败 3 次才放弃该段,避免游标永久卡死。进程重启会重置游标(锚定在上一轮),所以重启前丢失的那段不会自动补回 —— 这是刻意取舍:宁可丢一段,也不要每次重启都把整个会话历史重刷一遍日志。
3. 不冒充人设,也不让模型拼路径
systemPrompt.section() 里有一个是主会话的人设槽位(order: 0)。插件往那里塞 You have a persistent memory system… 等于冒充 DSH 给模型立规矩 —— 这条仍然成立。
本插件只用 950 这个空档(文件引用段 900 之后、工具说明段 1000+ 之前),且内容仅限解释自己的东西:索引长什么样、怎么读、边界在哪。角色设定与行为准则仍归 DSH 官方。
记忆根目录固定在 <dshHome>/memory-md,路径全部由插件计算,工具参数里没有 path / dir。
早先版本的提示词只给裸文件名(user_role.md、MEMORY.md),模型只能用自己的 cwd 补全,结果把文件写进了工作区:
D:\workspaces\ai\dsh-memory-md\MEMORY.md ← 污染工作区
D:\workspaces\ai\dsh-memory-md\memory_test.md
二、工具
四个工具,写入规范写在 description 里;记忆是什么归提示词段的协议。
memory_md_save
保存 / 更新一条记忆。插件负责路径与 MEMORY.md 索引,模型只提供内容。
| 参数 | 必填 | 说明 |
|---|---|---|
scope |
✅ | global(跨项目)/ project(当前工作区) |
type |
✅ | user / feedback / project / reference |
name |
✅ | 简短标题 |
description |
✅ | 一句话,说明什么时候这条记忆有用 —— 决定它日后能否被找到 |
content |
✅ | Markdown 正文 |
file |
覆盖已有的某个文件;省略则按 type + name 生成 |
同一文件重复保存 = 就地更新,索引条目不会重复。
memory_md_search
搜索记忆内容,返回匹配行及其文件。用窄词(报错信息、文件路径、函数名)而不是宽泛关键词。
memory_md_read
省略 file 则列出所有记忆(标题 / 类型 / 描述);给了 file 则读全文。
memory_md_journal
追加到当天的工作日志(记忆设置 → 工作留痕 打开时才有内容)。
日志属于当前工作区 —— 它记的是「这个项目里做了什么」,所以需要打开一个工作区;没有全局日志。跟具体项目无关的结论应该写成记忆(memory_md_save),而不是流水账。
一次调用 = 一个带时间戳的批次,每条 1-3 句,写清「做了什么 + 得出什么结论」:
# 2026-09-13
## 04:27:56
- 修了分隔符 bug —— 根因是并发写共用同一个临时文件名,后写的覆盖先写的,改成随机后缀。
- 补了并发回归测试:8 次并发写入全部保留。
## 04:27:57
- 加了后台总结:轮末起独立 LLM 调用,写记忆与日志,不往主对话塞消息。
为什么不是一句话流水账:结论才是事后翻看时真正要找的东西。
「研究了 X 的实现方式」看过等于没看;「X 用的是双块折叠,没有 section,所以不吃缓存优化」
才能还原当时的判断。判定标准见 docs/plan.md 第 7.3 节(正面清单 + 负面清单)。
同一天分几次写的,一眼可见 —— 不必靠条目顺序去猜。
参数:notes(字符串数组,一次提交多条)或 note(单条便捷写法)。
一次能说清的就别调多次,插件会把它们归到同一批次。
通常不需要手动调它。 轮末的后台总结会自动把本轮做了什么写进日志(见第一节第 2 点)。 这个工具留给需要精确补记的场合。
日志是只写不读的:不参与索引、不出现在 memory_md_search、也不会被 memory_md_read 列出。它记录「做了什么、结论是什么」供你事后翻看;要让某件事影响未来的对话,用 memory_md_save。
开关关闭时静默跳过(返回 written: false),不报错打断对话。
返回值里三个字段含义不同,别混:
| 字段 | 含义 |
|---|---|
stamp |
本批次的时间戳 HH:MM:SS |
entries |
本批次新增的条目数 |
total |
当天累计条目数 |
早先只有一个
entries,返回的却是累计值 —— 连写两条时看到2会误以为「一次写了 2 条」,进而误判成丢数据。拆开后就没有歧义了。
写入是原子的
日志采用「读 → 拼接 → 原子替换」,临时文件名带随机后缀。这是必须的:早先用 <path>.<pid>.tmp,同进程内两次写会共用同一个临时文件,后写的覆盖先写的再各自 rename —— 条目静默消失。tools 套件里有对应的回归断言。
时间戳的同秒问题
同一秒内多次调用会产生名字相同的小节(如两个 ## 04:27:57)。这不会丢数据,只是两个小节并排 —— 批次边界仍然可读。要更细就得带毫秒,但那是噪音,不值得。
二·五、写入频率
两条路径并存,互不重复:
| 路径 | 时机 | 谁决定 |
|---|---|---|
memory_md_save 工具 |
模型自己判断该记了 | 模型 |
| 后台总结 | 每轮结束时兜底 | 插件 |
后台总结怎么做的
监听 agent/turn-stopping,在轮末起一次独立的、无工具的 LLM 调用
(ctx.llm.stream()),由它总结本轮做了什么、有什么值得沉淀,然后插件自己
写记忆文件和日志文件。主对话全程不参与、不显示任何东西。
为什么不用子代理:ctx.subagents.start() 会创建真正的子 agent(有自己的
session、进会话列表、能调工具),还会再次触发 agent/turn-stopping —— 递归
风险。这里只需要一次模型调用,不是 agent,所以不会递归。
带来两条必须自己处理的保障(因为不走子代理,官方不为这次调用兜底):
- 超时 ——
llm.stream()没有内置超时。不兜的话 provider 一挂起, 内部状态永不复位,游标从此卡死、再也不写日志(比丢一段严重)。故配 60s 超时。 {{...}}中和 —— 官方interpolate()把注入文本里的{{...}}当提示词变量 严格校验,且对context()与section()都生效。记忆里含{{会抛错炸整轮, 并永久锁死那个工作区(每轮都炸、agent 无法自救,只能手工改MEMORY.md)。 故在注入边界把相邻花括号转义({{→{\{,语义不变、原文可还原)。 dsh-mneme 被 issue #40 追过同一个问题。
旧实现是反面教材。 它往主对话
inbox.append('next-step')塞一条 "Before this turn closes…" 的提醒:显示在对话里,还逼主模型再跑一步; 且投递时漏了source,loop 在轮次收尾路径上读message.source.kind直接抛Cannot read properties of undefined (reading 'kind'),整个回合失败。那段代码(
src/remind.mjs)已删除。regression-kind套件现在断言summarize.mjs里没有inbox.append/createUserMessage,且真跑一次 轮末时inbox.append一次都没被调用 —— 只要有人再把"提醒主模型"加回来, 测试立刻变红。
防重复与防卡死(当前实现)
⚠️ 早先这里描述一套已删除的「轮末提醒」机制(
remindedTurns按 turn 记账、 声称remind套件覆盖)—— 那套机制连同src/remind.mjs一起删掉了, 这段描述却留了下来,与上面「旧实现是反面教材」自相矛盾。现已改成描述实际生效的机制。
后台总结不会往对话里塞任何东西(无提醒、不逼主模型再跑一步), 所以不存在「模型看到提醒 → 不写记忆 → 无限追加」这个循环。 真正要防的是重复总结与卡死:
- 游标只在成功后推进 —— 失败 / 内容不足时游标原地不动,下一轮把这段一起带上
(跨回合补偿)。连续失败到
MAX_SUMMARY_ATTEMPTS(3 次)才放弃该段, 否则一段坏内容会让游标永久卡住。 - 主模型本轮写过记忆 → 不重复总结 —— 只认写操作
(
memory_md_save/memory_md_journal),只读的search/read不算。 判据只看本轮:用累积段会让一次调用永久污染后续所有轮。 - 超时 + 陈旧锁 ——
SUMMARY_TIMEOUT_MS(60s)兜住 LLM 调用本身;RUNNING_STALE_MS(5 分钟)兜住任何挂起路径,防running永久置位。 - 会话结束 force 触发 ——
agent/disposed时绕过门槛与防抖写一次, 否则最后一段对话没有「下一轮」可以补。 - 失败可见 —— 失败写进
error.log(与settings.json同级),不进.journal/。
全程 try/catch —— 任何异常都不得影响轮次收尾。
三、安装
以 link 方式装进 DSH 的 web profile。
profile 位置:<dshHome>/profiles/web/(Windows:C:\Users\<你>\.dsh\profiles\web\)
1. 建链接
cd ~/.dsh/profiles/web/node_modules
cmd //c "mklink /J dsh-memory-md D:\workspaces\ai\dsh-memory-md"
Windows 上必须用 junction(mklink /J)。Git Bash 的 ln -s 会退化成复制目录,改了源码不生效。建完用 test -L 确认。
2. 登记到 profile
~/.dsh/profiles/web/package.json 两处:
{
"dependencies": { "dsh-memory-md": "link:D:/workspaces/ai/dsh-memory-md" },
"dsh": { "profile": { "bundles": [ "...", "dsh-memory-md" ] } }
}
3. 安装并重启
cd ~/.dsh/profiles/web && pnpm install
然后重启 dsh(Host 半是 bundle 行插件,进程启动时装载)。
4. 验证
node D:/workspaces/ai/dsh-memory-md/test/run.mjs
四、目录结构
记忆根目录固定,不在任何项目目录内:
~/.dsh/memory-md/ # Windows: C:\Users\<你>\.dsh\memory-md\
├── settings.json # 插件设置
├── error.log # 错误日志(与设置同级,排查看这层)
├── global/ # 用户级(跨项目)
│ ├── MEMORY.md # 索引(插件维护,唯一入口)
│ ├── memory/ # 记忆正文
│ │ └── user_xxx.md
│ └── .journal/ # 留痕(默认关)
│ └── YYYY-MM-DD.md
└── {slug}/ # 项目级(结构同上)
├── MEMORY.md
├── memory/
│ ├── feedback_aaa.md
│ └── project_bbb.md
└── .journal/
索引在作用域根,正文在 memory/ 子目录,日志在 .journal/ —— 三者同级。
这样作用域根一眼看清结构,memory/ 与 .journal/ 也彼此对称。
索引里的链接相应带子目录:- [数据库端口](memory/reference_db.md) — …。
从旧版升级(正文曾平铺在作用域根):跑一次迁移脚本 —— 这是一次性运维动作, 不是插件运行时行为(新写入本来就会落在正确位置)。
node scripts/migrate-memory-layout.mjs --dry-run # 先看会做什么 node scripts/migrate-memory-layout.mjs # 实际执行改了目录结构但还没重启 DSH 时,旧进程仍会往旧路径写新文件 —— 所以重启后要再跑一次,把这段时间散在作用域根的文件收进去。 脚本幂等:已搬过的不会再动,没得搬时直接报「无事可做」。
安全保证:只搬带已知
type:frontmatter 的真记忆(别的文件一律不动), 目标已存在则跳过并报告,绝不覆盖,只rename不改内容。跑前建议先备份。
{slug} 由工作区绝对路径压缩而来(盘符与分隔符转 -、全小写):
D:\workspaces\ai\dsh-memory-md → d-workspaces-ai-dsh-memory-md
五、记忆文件格式
---
name: 数据库端口
description: 本地数据库跑在 5433
type: reference
---
正文。feedback / project 类型建议写成:规则或事实,然后 **Why:** 与 **How to apply:** 两行。
索引 MEMORY.md 由插件维护,一行一条,超过 200 行会被截断(只影响读取时的截断,文件本身不动):
- [数据库端口](memory/reference_db.md) — 本地数据库跑在 5433
六、设置
设置 → 记忆设置:
| 项 | 默认 | 说明 |
|---|---|---|
| 启用记忆 | 开 | 关掉后不注入上下文快照、拒绝保存、不做后台总结;读与搜索仍可用 |
| 工作留痕 | 关 | 是否允许写日志(只写不读)。后台总结与 memory_md_journal 都受它控制 |
| 触发轮数 | 2 | 累积够这么多轮就跑一次后台总结。与「触发字符数」任一达标即触发 |
| 触发字符数 | 2000 | 这一段新增内容够长也触发一次。单条很长(如一次长分析)时不必等够轮数 |
| 在这些预设下停用 | 空 | 一行一个 preset id,支持 * 通配(如 presetmd-*)。这些预设里的对话不读也不写全局记忆 |
两个阈值清空即用默认值(服务端归一化兜底);填非正数也回落默认, 不会静默夹到下限。改动点「保存」后生效。
预设级停用
本插件挂在 host 平面,默认对所有 agent 生效 —— 包括官方四个预设。 但某个预设可能自带独立记忆(跟着预设走的人格记忆),那时全局记忆必须整体让位, 否则两套记忆同时生效、互相干扰。
disabledPresets 就是为此。命中后三条入口全停:
| 入口 | 行为 |
|---|---|
四个 memory_md_* 工具 |
直接拒绝并说明原因 |
| 后台总结 | 不跑(不写记忆、不写日志) |
| 记忆注入 | 不注入协议段与索引快照 |
为什么连读也停:只拦写会让 agent 读到一个它不该依赖的记忆库, 于是回答里混进别的项目的上下文 —— 比完全不生效更难排查。
判定依据是 session.header.agentPreset(durable,随会话保存)。
没有 preset id 时永不匹配,即默认全局生效 —— 官方预设不受影响。
为什么不做成「只在某预设下生效」的白名单:那会让新装的预设默认没有记忆。 「默认有、特定预设退出」更符合直觉,漏配时也只影响那一个预设。
设置页有开关 + 两个触发阈值 + 四条固定路径(记忆目录、用户级目录、设置文件、错误日志),
外加预设停用名单。改动点「保存」才生效(攒草稿,不即时提交)。
设置存 <dshHome>/memory-md/settings.json。
刻意不显示任何与会话有关的东西 —— 不列条目、不显示记忆卡片与计数、
不显示项目级目录或留痕目录。原因:设置页是全局页面,拿不到「当前会话」,
Host 半只能退回 sessions.list() 去猜工作区,而官方文档明确该列表是
创建顺序 —— 于是永远返回最老的会话,切换会话后界面仍显示上一个会话的
路径。猜错的路径比不显示更糟,所以整块去掉。
七、开发
node test/run.mjs # 跑全部 15 个测试套件
| 套件 | 覆盖 |
|---|---|
differential |
截断逻辑与 CodeBuddy 2.150.0 真实 bundle 逐字节比对 |
load |
按包名装载插件(与真实 loader 一致),确认工具与两段式注入注册 |
paths |
路径解析到 DSH 用户目录,不落工作区 |
routes |
HTTP 接口:只给与会话无关的路径、内容接口已移除 |
client |
client 半依赖白名单与注册契约 |
empty-state |
设置页不显示条目、卡片、计数与会话相关路径 |
inject |
两段式注入:索引标签、只注入索引、截断、协议不进快照 |
summarize |
后台总结:解析、写记忆与日志、开关与异常隔离 |
preset-exclude |
预设停用名单:读写日志全拦 |
regression-kind |
从真实会话日志取证:缺 source 会崩回合 |
schema |
工具 schema 过 DSH 真实的 assertSupportedJsonSchema |
tools |
工具行为:写入位置、索引维护、越界拒绝 |
代码结构
| 文件 | 作用 |
|---|---|
src/index.js |
Host 半:注册工具 + 两段式注入 + HTTP 接口 |
src/tools.mjs |
四个记忆工具的实现与说明书 |
src/inject.mjs |
注入:MEMORY_PROTOCOL(提示词段)+ renderMemoryIndex(快照) |
src/summarize.mjs |
轮末后台总结:独立 LLM 调用,写记忆与日志 |
src/schema.mjs |
schema 转换(不用 defineTool,见下) |
src/routes.mjs |
HTTP 接口 /memory-md/api/* |
src/settings.mjs |
设置读写 |
src/store.mjs |
共享写入原语:原子写、记忆正文、日志追加、索引行、错误日志 |
src/context.mjs |
路径解析 |
src/codebuddy-port.mjs |
截断与 frontmatter(CodeBuddy 移植) |
client/client.js |
设置页(settings.section) |
⚠️ 为什么不用 defineTool
@deepseek-ai/dsh-tools 不在 profile 的可解析范围内(profile 只暴露 cosmokit 与 schemastery),插件的 import 必然失败。
好在 ctx.tools.register() 要的本来就是纯 JSON Schema(内部调 assertSupportedJsonSchema,不是 spec 转换器),所以 src/schema.mjs 自己做转换。两个硬性要求:
- 可选字段必须完全不写
required;写required: false会被拒绝 required只能出现在对象根,属性节点上带着它会被拒绝
schema 套件用 DSH 真实的校验器验证这两点,而不是靠约定。
与同机其它插件的关系
同机还装着 dsh-preset-md(伙伴设置),它也占用 settings.section。两者是并列的两页,互不替换:slot id 不同、各插各的 <style>(前缀 .mmd- vs .pmd-)、不共享模块。
样式令牌与参数行布局沿用 dsh-preset-md 的约定 —— 两个页面并排时不该长得像两个产品。这是刻意的视觉对齐,不是代码复用。
⚠️ client 半不能引用已消失的包
真事故:两个设置页同时变成「裸 HTML」。
根因是两者的 client 都 require('@deepseek-ai/dsh-client-ui-primitives'),
而该包在当前 DSH 版本里已不存在(find 全盘无结果,dsh/package.json 也未提及):
FAIL @deepseek-ai/dsh-client-ui-primitives MODULE_NOT_FOUND
OK @deepseek-ai/dsh-client-ui-settings
dsh-preset-md 在 factory 顶层解构它,所以一抛错 apply 就从不执行 →
ensureStyles() 从不调用 → 整页裸样式。
教训:client 半的任何外部 require 都必须先确认包真的存在,
不能靠「别的插件这么写」来推断。
client 套件把这件事写成显式白名单 —— 新增依赖必须同时改测试,
并且点名禁止 primitives 再被引入。
八、卸载
# 1. 从 profile 的 package.json 移除 dsh-memory-md(dependencies 与 bundles 两处)
# 2. 删链接并重装
cd ~/.dsh/profiles/web/node_modules && cmd //c "rmdir dsh-memory-md"
cd ~/.dsh/profiles/web && pnpm install
记忆文件不会被删(在 ~/.dsh/memory-md/),需要时手动清理。
No comments yet. Be the first to write one.