OpenViking 记忆(DeepSeek Harness 插件)
一个可安装的 DeepSeek Harness 插件包,为 DSH 增加 OpenViking 自动召回、会话捕获、viking:// URI 保护,以及可被模型调用的记忆工具——均在 DSH 的插件页(插件 → 已安装 → OpenViking 记忆)中配置。
功能特性
- 自动召回(Auto-recall) —
agent/pre-step 使用当前步骤的输入进行检索,并追加一条持久化、带来源标注的插件用户消息。
- 用户画像注入(Profile injection) —
agent/created 注入 OpenViking 用户画像与可用记忆索引。
- 会话捕获(Session capture) —
session/event 捕获用户、助手以及(可选)工具结果消息,无需抓取对话记录;turn/end 在待处理令牌数达到阈值时提交。
- 离线韧性(Offline resilience) — 写入失败的内容进入
~/.openviking/pending/,并在下次会话开始时重放。
viking:// 保护 — tools/pre-execute 阻止 DSH 文件系统与 Shell 工具将虚拟 URI 当作本地路径处理。
- 技能注入(Skill catalog) — 注册名为
openviking 的 DSH 技能 provider,把保存在 OpenViking 中的技能(viking://user/<space>/skills/ 与共享的 viking://agent/skills)注入进会话的 <available_skills> 目录;模型可像本地技能一样用 skill 工具按需加载完整正文。
- 记忆工具 — 15 个
viking_* 工具,涵盖检索、读写、浏览、归档展开、监视管理与技能管理(见工具)。
- 配置 — 连接身份、API 密钥与召回/捕获调优在 插件 → 已安装 → OpenViking 记忆 详情页的配置表单中集中配置,保存后即时生效,无需重启。
环境要求
@deepseek-ai/dsh 0.2.0-rc.2 或更新的 0.2.x 版本(peer 声明为 ^0.2.0-rc.2)
- Node.js
^22.19.0 或 >=24
- 可访问的 OpenViking 服务器
安装
从本地检出目录安装(首次使用前先运行 pnpm install && pnpm run build):
dsh plugin --profile web add "$PWD"
本目录是上游 @nextnowlabs/dsh-openviking@0.3.10 的源码副本,包名已改为 @my-bundles/openviking 且 private: true:profile 用 link: 指向本目录,改完 src/ 跑一次 npm run build 再让服务重读即可生效,全程不经过 registry。想跟上游代码用 npm view @nextnowlabs/dsh-openviking version 比对——注意上游版本号只表示「抄自哪一版」,与本包自身的 version 无关:本包 version 跟随 DSH 版本线(当前 0.2.0-rc.1,规则见版本规则)。
确认 profile 中包含该插件包:
dsh --profile web --dump-config
该包的补丁会在一个隔离了 openvikingMemory 服务的 Cordis 组内挂载运行时。
配置
OpenViking 的配置在 DSH Web → 插件 → 已安装 → OpenViking 记忆 → 详情页 的配置表单中完成;未填写的字段使用内置默认值。页面只在 Host 正在运行本插件那一行时出现(ctx.configForms.whileServed),插件被停用或未安装时不显示。
该页面是插件的配置入口:它把用户填写的值暂存(staged),点击「保存」时一次性以修订号(revision)为栅栏写入,未保存的编辑会在离开页面时丢弃。DSH 0.1.7 起,配置模型是补丁即配置——插件不再注册设置命名空间,配置写回 profile 补丁中本插件那一行的 config;行 id 为 openviking-memory-runtime(由本包的 cordis.patch.yml 声明),DSH 就用这个 id 寻址配置表单、settings/document-updated 事件与浏览器页面。运行时持有的每个字段都是 DSH 维护的 volatile 引用,写入后插件在收到该行的事件时重新解析整份配置并热应用。
下表列出全部设置字段;「界面」列为 ✓ 表示可直接在上述页面中编辑,其余字段可在 profile 补丁的该行 config 中提供。
连接
| 字段 | 界面 | 默认值 | 用途 |
|---|
服务器端点 endpoint | ✓ | http://127.0.0.1:1933 | OpenViking 服务器基础 URL |
凭据引用 credential | | OPENVIKING_API_KEY | 保存 Bearer API 密钥的 DSH 凭据引用(环境风格名称);密钥本体存储在 DSH 凭据存储中,不写入补丁 |
账号 account | ✓ | (空) | 受信模式账号 |
用户 user | ✓ | (空) | 受信模式用户 |
Actor 对等节点 ID peerId | ✓ | (空) | 显式对等节点;留空则按会话工作区推导 |
请求超时 requestTimeoutMs | | 10000 | 所有 HTTP 请求的超时毫秒数 |
召回
| 字段 | 界面 | 默认值 | 用途 |
|---|
工作区对等节点 workspacePeer | ✓ | 开 | 从每个会话工作区推导 actor 对等节点 |
召回对等节点范围 recallPeerScope | ✓ | all | all 跨工作区召回;actor 仅限本会话对等节点 |
最大召回条数 recallLimit | ✓ | 10 | Pre-step 召回上限 |
召回令牌预算 recallTokenBudget | ✓ | 2000 | 每个召回块的令牌预算 |
分数阈值 scoreThreshold | ✓ | 0.35 | 最低召回分数 |
召回硬截止 recallTimeoutMs | ✓ | 6000 | 单次 pre-step 召回的硬性截止毫秒数;超时则跳过该步召回(画像与召回并行执行),避免慢/远端服务器拖住模型步 |
提交令牌阈值 commitTokenThreshold | ✓ | 20000 | 触发提交的待处理令牌数阈值 |
服务端查询扩展 recallQueryExpansion | | auto | auto 启用服务端查询扩展;off 关闭 |
召回内容最大字符 recallMaxContentChars | | 500 | 每条召回项最多展示的字符数 |
召回优先摘要 recallPreferAbstract | | 开 | 回退召回优先使用摘要而非全文 |
最小查询长度 minQueryLength | | 3 | 低于该长度不触发召回 |
画像令牌预算 profileTokenBudget | | 10000 | 会话开始时画像注入的令牌预算 |
注入画像 injectProfile | ✓ | 开 | 是否在每个会话注入 user-profile + <available-memories> 画像块;关闭后不注入,初始化也不再拉取画像(动态召回不受影响) |
技能注入 injectSkills | ✓ | 开 | 将 OpenViking 中保存的技能注入 DSH 技能目录 |
捕获
| 字段 | 界面 | 默认值 | 用途 |
|---|
逐事件同步捕获 syncTurns | ✓ | 开 | 在 session/event 上同步捕获 |
捕获工具结果 captureToolResults | ✓ | 关 | 将工具结果消息捕获进记忆 |
捕获助手轮次 captureAssistantTurns | ✓ | 开 | 将助手回复捕获进记忆 |
捕获模式 captureMode | | semantic | 捕获模式:semantic 或 keyword |
单条捕获最大字符 captureMaxLength | | 24000 | 每条捕获消息的最大字符数 |
工具结果捕获最大字符 captureToolMaxChars | | 1000000 | 每条捕获工具结果的最大字符数 |
提交保留最近条数 commitKeepRecentCount | | 10 | 提交后保留在活动会话中的最近消息条数 |
补丁还可以携带插件配置(含不在界面展示的字段,如 captureMode、requestTimeoutMs);该行的 config 就是 DSH 配置页面的存储位置,界面写入的值也会落到这里:
- insert:
- id: openviking-memory
name: '@deepseek-ai/cordis-plugin-group'
group: true
isolate:
openvikingMemory: true
config:
- id: openviking-memory-runtime
name: '@my-bundles/openviking'
config:
endpoint: http://127.0.0.1:1933
recallTokenBudget: 2000
scoreThreshold: 0.35
captureToolResults: false
commitTokenThreshold: 20000
captureMode: semantic
requestTimeoutMs: 10000
行为说明
- API 密钥存放在 DSH 凭据存储:插件配置只携带
credential 引用(默认 OPENVIKING_API_KEY)。每个 OpenViking 请求在发出前经 ctx.credentials.resolve(credential) 解析密钥并以 Authorization: Bearer 发送,因此凭据变更在下一个请求即生效,无需重启;设置页面通过 DSH 的 Remote 凭据域(credentials/describe、credentials/set)读写密钥,浏览器只看到「是否已配置」与来源,永不见其明文。
agent/created(DSH 的串行事件,在模型循环开始前 await)通过 agent.inject() 注入 OpenViking 画像与可用记忆索引(injectProfile 关闭时不注入,且初始化不再拉取画像)。
agent/pre-step 使用当前步骤的输入进行检索,并将一条持久化、带来源标注的用户消息追加到同一步骤。画像与召回上下文以会话事件进入,可重放、对压缩可见且不会进入请求头。
- 画像与召回在
agent/pre-step 中并行构建,并受 recallTimeoutMs 硬性截止时间约束:慢/远端服务器超时后该步直接跳过召回(或画像),绝不阻塞模型步;画像构建在基础链路之前启动,与系统提示词装配重叠。
session/event 捕获用户、助手以及(可选)工具结果消息,无需抓取对话记录。
turn/end 检查待处理令牌阈值,并在需要时提交。
- 写入失败的内容进入共享的待处理队列,在下次会话开始时重放。
tools/pre-execute 阻止 DSH 文件系统与 Shell 工具将 viking:// URI 当作本地路径处理。
ctx.skills 上注册名为 openviking 的技能 provider:目录发现走 GET /api/v1/skills,正文按需经 GET /api/v1/skills/{name}?include_content=true 加载。每个会话构建技能目录时都会重新发现,OpenViking 中新增/修改/删除的技能随即反映到 <available_skills>。
每个 DSH 会话都映射到 OpenViking 中的 dsh-<session-id>。由工作区推导的 actor 对等节点按会话解析,并随每个会话级请求发送。会话是惰性创建的:只有当实际捕获到消息、或有待重放的离线写入时才会在 OpenViking 中落盘,因此关闭捕获(syncTurns / captureAssistantTurns / captureToolResults 均关闭)的会话不会在服务器上留下空的会话记录。
技能注入
开启 injectSkills(默认开)后,保存在 OpenViking 中的技能会作为名为 openviking 的 provider 进入 DSH 技能目录,与本地文件系统技能共用同一套 skill 工具与 <available_skills> 机制:
- 数据来源 —
GET /api/v1/skills 返回当前用户私有技能(viking://user/<space>/skills/)与账户共享 Agent 技能(viking://agent/skills)的合并列表;同名时私有技能优先。
- 技能格式 — 与 DSH 本地技能一致:
SKILL.md 携带 YAML frontmatter(name、description,可选 tags、allowed_tools)。正文中的 frontmatter 会被剥离,仅把说明正文注入 <skill_instructions>。
- 优先级 — 排名固定为
550:本地用户技能(400–500)优先于同名 OpenViking 技能,而 OpenViking 技能仍高于内置技能(600)。
- 失败韧性 — 服务器不可达时该轮发现报告为不完整(不会把空目录当作权威结果缓存);无技能时贡献为空,不影响会话。
用 OpenViking 的 ov add-skill ./skills/my-skill/(或 Web 端)保存技能后,新建 DSH 会话即可在技能目录中看到并加载它。
工具
该插件包注册了以下工具:
viking_search — 语义检索 OpenViking 记忆、资源与技能
viking_read — 按 abstract / overview / full 读取 viking:// 内容
viking_browse — 列出目录或查看 URI 元数据
viking_tree — 递归列出目录树
viking_write — 写入文本(replace / append / create)
viking_edit — 精确字符串替换
viking_grep — 按正则搜索文件内容
viking_glob — 按文件名通配匹配
viking_remember — 将事实记入当前会话
viking_forget — 永久删除
viking_add_resource — 摄入远程 URL 供检索
viking_archive_expand — 展开当前会话的归档
viking_list_watches — 列出监视任务
viking_cancel_watch — 取消监视任务
viking_manage_skill — 创建 / 更新 / 删除技能(SKILL.md 上传,同名即覆盖;可指定共享技能根)
viking_forget 与 viking_manage_skill(delete 动作)执行永久删除。调用它们的模型只应在用户明确要求删除时使用。
开发
本仓库是一个 pnpm/TypeScript 项目,lib/ 为编译产物(不随仓库提交):
pnpm install # 安装 dsh devDependencies
pnpm run build # tsc server + tsc client + client bundle -> lib/
pnpm test # vitest run tests
pnpm run typecheck # server + client 的 no-emit 类型检查
lib/ 由 pnpm run build 生成,npm publish 的 prepack 钩子会在发布前自动重新构建。
live-recall.spec.ts 是一个针对真实 OpenViking 服务器的可选端到端门禁:设置 OPENVIKING_E2E=1 并在测试配置中填入连接凭据即可启用;否则跳过。
DSH 0.1.7 适配要点
0.1.7 重做了配置与设置域,本插件随之改动如下(升级 DSH 时先看这里):
- 设置命名空间已不存在。
SettingsProvider.register() / installSection()、settings.yaml、SettingsNamespace 全部移除;配置就是 profile 补丁里本插件那一行的 config,由该行的 Cordis Config schema 描述,并以行 id(openviking-memory-runtime)寻址。插件侧的常量是 OPENVIKING_ENTRY_ID,浏览器侧镜像同一字面量。
- 可配置字段必须声明
.volatile()。DSH 只用声明了 volatile 的字段构建配置表单,并且这类字段在插件里是 Volatile<T> 引用(用 get() 读取)而不是拷贝值;tests/config.spec.ts 与 scripts/smoke-artifact.mjs 都会断言这一点。resolveConfig() 同时接受引用与普通对象。
- 配置变更由事件驱动:DSH 原地更新引用并在
settings/document-updated 上公告该行;插件据此重新解析整份配置并热应用(runtime.reconfigure),无变化的重复公告由签名比对挡掉。
- 消息来源不再有通用
plugin 种类:每个生产者声明自己的 MessageSourceMap 条目。本插件声明 openviking-memory,捕获侧的白名单也从「跳过 plugin」改为「只收人类输入」。
- 浏览器设置页改为 Plugins 页的一个座位:旧的
settings.plugin.item 卡片、ctx.settingsScope 与 /_dsh/openviking/settings 同源路由均已移除。页面以 view: 'summary' | 'page' 渲染,配置读写走 ctx.configForms,API 密钥读写走 DSH 的 Remote 凭据域(credentials/describe、credentials/set)。当时座位是 plugins.item;0.2.0 起改为 plugins.bundle.config,原因见下节。
dsh-host-webserver 依赖已随该路由一并移除。
DSH 0.2.0-rc.2 适配要点
0.2.0-rc.2 引入了 peer 兼容性门禁,本插件随之改动如下:
@deepseek-ai/dsh-* 的 peer 范围会被运行时校验。evaluatePluginCompatibility()(@deepseek-ai/dsh-app-boot)把清单里每个 @deepseek-ai/dsh / @deepseek-ai/dsh-* 的 peer 范围与运行中的 DSH 版本比对:安装/升级时插件管理器以 incompatible-version 拒绝安装(dsh: installation rejected: ... / nothing was installed);对已安装的插件,profile 启动会跳过该 bundle 不加载(dsh: skipping profile bundle ...),插件列表页同样报 incompatible-version。唯一放行方式是按「插件@版本 × DSH 版本」精确豁免:dsh plugin allow-version <pkg@version> --dsh-version <exact> --accept-risk。因此留在旧版本线上的 peer 会让包在新 DSH 上装不上——本包的 peer 已全部改为 ^0.2.0-rc.2,engines.dsh 声明同一条线,tests/bundle.spec.ts 会从 devDependency 的固定版本反推出当前版本线,并断言每个 peer 都覆盖该固定版本,避免下次升级时漏改。
engines.dsh 是新增的声明式字段(DshEnginesManifest.dsh),目前没有任何读取方强制执行,仅作兼容性声明。
dsh.client.external 是新增的客户端清单字段(精确的模块表请求,位于隐式基线之外)。本插件不声明它:浏览器包在运行时只 require react/jsx-runtime 与 @deepseek-ai/dsh-client-ui-primitives,两者都在 0.2.0-rc.2 的隐式基线内(react、react/jsx-runtime、react-dom、react-dom/client、cordis、dsh-client-store、dsh-client-ui-slots、dsh-client-ui-primitives、dsh-client-ui-dockkit)。
- 插件配置页的座位换了,本包已随之迁移。0.2.0 把插件管理页提为侧边栏顶级「插件」页,槽位契约也随之明确:
plugins.item 是官方设置页的座位,渲染在该页的官方分组里,第三方插件注册它就会和 Shell / Agent loop / Web search 并排显示成官方插件(0.3.9 的行为)。第三方 bundle 自己的配置有两个正路:plugins.bundle.config(key = 包名,表单内嵌在该 bundle 的详情页)与 plugins.row.config(key = <包名>#<行 id>,在组件行上给一个「配置」入口)。本包改用前者:key: '@my-bundles/openviking'(上游副本时代为 @nextnowlabs/dsh-openviking;key 必须等于 profile 里实际安装的包名,否则配置页不会出现在该 bundle 的详情页),于是配置表单出现在 插件 → 已安装 → OpenViking 记忆 → 详情页。keyed 槽没有 label/order,页面标题与一句话简介改由包内 locale/en.json / locale/zh.json 的 meta.title / meta.description 提供(package.json 相应新增 ./locale/*.json 导出与 files 条目)——这是 DSH 读取插件展示元数据的唯一位置(PluginPackages.metaOf)。 会在构建产物上断言座位名、包名 key,并断言没有注册 。
发布
发布身份与本地身份是两回事。 本副本的本地身份是 @my-bundles/openviking + private: true(profile 以 link: 引用,cordis.patch.yml 的行与配置座位都依赖它);发布身份是 @nextnowlabs/dsh-openviking(沿用上游既有 npm 包名)。
scripts/publish.sh 负责发布到 npmjs 官方 registry,方式是 staging 发布:
- 发布身份的唯一来源是
scripts/publish-identity.mjs(PUBLISH_NAME);scripts/ 里其它文件不得再写这个字面量,tests/publish-identity.spec.ts 会扫目录守着。
mktemp -d 复制包目录(排除 node_modules / .git / .npm-cache / lib / .client-build)→ 改写副本里的身份 → 用仓库真实 node_modules(symlink)在 staging 里跑真实 npm run build → 身份自检 → 在 staging 里 npm publish --ignore-scripts。真实 package.json / cordis.patch.yml / lib/ 都不被发布流程改写,版本提升也只发生在副本里。
三处身份引用(消费者装上包后真正会被加载的)在 staging 里都必须等于发布名:
| 位置 | 本地构建 | staging 发布构建 | 注入方式 |
|---|
package.json.name | @my-bundles/openviking | @nextnowlabs/dsh-openviking | publish-identity.mjs --write(顺带删 private) |
cordis.patch.yml 行 name(及其它指向本包的引用) | @my-bundles/openviking | @nextnowlabs/dsh-openviking | publish-identity.mjs --patch |
lib/client.js 模块 id + plugins.bundle.config 座位 key | @my-bundles/openviking | @nextnowlabs/dsh-openviking | 构建期由 scripts/build-client.mjs 从 package.json.name 注入(src/client/index.tsx 的 @@BUNDLE_NAME@@ token),浏览器半不在运行时读 manifest |
- 自检:
publish-identity.mjs --assert-staged 扫描 staged 的 package.json / cordis.patch.yml / lib/** / locale/**,本地包名出现次数必须为 0,且发布名必须落在 patch 行与 lib/client.js(模块 id + 座位 key);不通过则中止发布(publish.sh 会打印逐文件计数)。
--dry-run 在 staging 里跑 npm pack --dry-run,打印 staging 路径、身份自检结果、三个身份点的实际内容与待发布 manifest 摘要,并断言 tarball 名为 nextnowlabs-dsh-openviking-<version>.tgz。--keep-staging 可保留 staging 目录便于排查(默认自动清理)。
--no-git 声明零 git 动作:不 tag、不 push,也跳过 git 预检(配合 --skip-checks 用在有大量未提交改动的开发树上)。
ℹ️ staging 会重建 lib/,所以 staged lib/** 与仓库里 committed lib/ 字节不同(预期):committed lib/ 是本地构建产物(id/座位 key 都是本地包名,供 link: 的 profile 使用),staged lib/ 是发布构建产物(都是发布名)。两者由同一份 src/ + 各自的 package.json.name 生成;不要为了让它们"看起来一致"去改 committed lib/,本地照常 npm run build 即可。
版本规则
本包的 version 跟随所依赖的 DSH 版本线,不走上游的 patch/minor/major(同为移植包的同一条规则,实现在本包的 scripts/version.mjs):
- 基线 base =
package.json 里 @deepseek-ai/dsh-* devDependency 钉死的精确版本去掉 prerelease 段(当前 0.2.0-rc.2 → 基线 0.2.0,故本包当前版本 0.2.0-rc.1);
- 版本格式
^<base>-rc\.<N>$,N 从 1 起(rc.0 不是合法发布版本);同一基线每发一次版 N+1,依赖线换到新基线(如 0.2.1)则重置为 <新基线>-rc.1;
- 发版守卫:当前
version 必须满足 ^<base>-rc\.\d+$(N ≥ 1),前缀不等于基线(或还是旧的 0.3.10 形态)时脚本报错并给出重置指引;
- peer /
engines.dsh 保持该版本线的 caret 范围(^0.2.0-rc.2)不随发布版本号变动——tests/bundle.spec.ts 会从 devDependency 反推版本线并断言每个 peer 覆盖它。
tests/version.spec.ts(19 项)覆盖 parseVersion / dshBase / nextVersion(同线递增、跨基线重置、旧格式重置)/ assertVersionForBase / 非法输入,以及 version.mjs 面向 bash 的 CLI 契约(--next / --base / --assert-current / --target 只输出裸版本号、失败退出码 1)。manifest 守卫是规则级的:base 由 dshBase(manifest) 推导,只断言 ^<base>-rc\.\d+$ 与「守卫通过」,不钉死当前这一次的版本号;另有「下一次发版仍绿」的模拟断言(<base>-rc.2 / -rc.10 通过,跨线与 rc.0 失败),所以合法发版不会让这套测试自伤。
tests/publish-identity.spec.ts(20 项)守着发布身份:本地/发布名映射、rewriteManifestForPublish、rewritePatchForPublish(纯函数/幂等/不误伤)、staging 自检(含残留的夹具必须报错、干净夹具通过、缺 lib/ 报错)、scripts/ 里除 publish-identity.mjs 外无发布名字面量,以及 src/** 里既无本地名也无发布名(身份走 @@BUNDLE_NAME@@ 构建期注入)。
npm run release # staging 发布当前版本(等价于 ./scripts/publish.sh)
npm run publish:dry # dry-run:staging + 构建 + npm pack --dry-run,不改真实文件
./scripts/publish.sh --bump rc --push # 按规则提升到下一个 rc 并推送 git tag(--bump 只接受 rc)
./scripts/publish.sh --version 0.2.0-rc.3 # 显式指定版本:须符合规则且大于当前版本,只写 staging
./scripts/publish.sh --dsh-base 0.2.1 # 依赖线换到 0.2.1 时覆盖基线(需先把 version 重置为 0.2.1-rc.1)
./scripts/publish.sh --no-git --skip-checks # 零 git 动作的发布(开发树有未提交改动时)
./scripts/publish.sh --keep-staging # 保留 staging 目录便于排查
./scripts/publish.sh --tag beta # 发布为 beta dist-tag
默认发布 manifest 里的当前版本;要换版本用 --bump rc(按规则算下一个)或 --version <x.y.z-rc.N>。--bump patch|minor|major|premajor|… 是上游的旧玩法,本包已明确拒绝。
注意:不要直接运行裸 npm publish。publish 是 npm 的生命周期脚本名,
npm 在上传完成后会再次执行它,导致 publish.sh 递归重入并报“版本已存在”。
统一使用 npm run release(或直接调用 ./scripts/publish.sh)。
发布前会自动检查:位于 main 分支、工作区干净(--skip-checks 可跳过;--no-git 也会跳过这两项)、已登录 npmjs(dry-run 跳过)、当前版本满足 ^<base>-rc\.\d+$、目标版本(按发布包名查询)未被占用。需要二步验证时用 -o <otp> 或 NPM_OTP 环境变量。首次发布先执行 npm login --registry https://registry.npmjs.org/。
许可证
MIT