dsh-plugin-dev-kb:写 dsh 插件时的本地官方文档

前言

在 DSH 插件开发里,经常需要确认 Tool、配置、服务、事件、打包或 LLM 适配器的接口与行为。已有做法通常是打开 DeepSeek Harness 官方文档站,按页面搜索,再把结论交给 agent 或写进自己的笔记。

dsh-plugin-dev-kb 做的事情更直接:把 DeepSeek Harness 官方文档站内容整理为 dsh 可读取的本地文件,并加入仓库里的补充开发参考。agent 做插件开发任务时可以自动加载这个知识库,按任务场景定位文档,再按需读取文件。

下面介绍它是什么、包含哪些资料、如何安装启用,以及适合什么场景。

这是什么

dsh-plugin-dev-kb 是 Pasumao 维护的 dsh 插件,许可为 MIT。

它的定位是:写 dsh 插件时的随身官方文档。

它把 DeepSeek Harness 官方文档站内容整理为 dsh 原生可用的形态,同时把仓库中未发布到站点的开发参考放进同一个 kb/ 目录,并通过 dsh-plugin-dev-kb 技能让 dsh 在插件开发任务中自动加载知识库。

它不是运行时增强插件,也不注册工具。可以把它理解为一个本地文档库加一个 agent 技能入口。

核心功能

下面列出的能力均来自已核实信息。

  • 官方文档完整镜像:DeepSeek Harness 官方文档站全部内容整理为 dsh 原生可用的形态,中英双语共 182 页,链接按站点路由重写。
  • 仓库补充文档:未发布到站点的 56 篇开发参考,包括术语表、防御模式、模块图、测试策略、事故复盘、i18n 规范等。
  • agent 友好dsh-plugin-dev-kb 技能让 dsh 在插件开发任务中自动加载知识库。
  • 主题导航kb/meta/topics.md 按任务场景映射要读的文件。
  • 全量检索kb/meta/search-index.json 提供 241 文件全量索引。
  • 人侧可用:可直接浏览 kb/ 目录,或打开 kb/INDEX.md 按 URL 对照查阅。
  • 纯数据插件:零运行时依赖,不注册任何工具。
  • 无需配置:不读取环境变量,不需要 API Key / token,不写配置文件。

安装与启用

先做安装。推荐 npm 命令如下:

dsh plugin --profile web add dsh-plugin-dev-kb

再做一次性手动挂载。该插件是纯数据 + 技能插件,不自带 bundle 自动挂载,需要在 profile 的 cordis.patch.yml 末尾加:

- insert:
    - id: dsh-plugin-dev-kb
      name: dsh-plugin-dev-kb

然后重启或新建 dsh 会话。技能清单在会话启动时快照,所以新会话启动后,dsh-plugin-dev-kb 技能才会进入可用技能列表。

运行要求:

peerDependencies: @deepseek-ai/cordis ^4.0.1
engines: node >=18

典型用法

agent 侧

写插件、Tool、配置、服务、事件、打包或 LLM 适配器时,可以先让 dsh 加载 dsh-plugin-dev-kb 技能,然后读:

kb/meta/topics.md

这一步是用主题导航定位当前任务需要读哪些文件。

定位之后,再按需读取或检索具体文件。全量索引在:

kb/meta/search-index.json

人侧

人侧可以直接浏览:

kb/

如果希望按站点 URL 对照本地文件,可以打开:

kb/INDEX.md

快速验证

重启后开一个新会话,直接问:

帮我写一个最小的 dsh 插件

agent 会自动加载 dsh-plugin-dev-kb 技能,按 kb/meta/topics.md 定位文档后再动手。

如果看到 agent 引用:

kb/site/...

这类路径,即验证通过。

适用场景与注意

适合这些情况:

  • 经常写 dsh 插件、Tool、配置、服务、事件、打包或 LLM 适配器。
  • 希望 agent 在写代码前先读本地文档,而不是只凭提示词推断。
  • 需要按任务场景查找官方文档或仓库补充文档。
  • 希望人侧也能直接浏览、对照 URL 和文件。

需要注意:

  • 插件以当前 dsh 进程权限运行,安装前应检查源码与许可证。
  • 当前仓库许可为 MIT。
  • 知识库内容为官方文档的镜像整理,索引与导航由 AI 辅助生成,并经过人工核对。
  • 该插件不注册工具,不读取环境变量,不需要 API Key / token,不写配置文件。
  • 技能进入可用列表依赖会话启动快照,安装后需要重启或新建 dsh 会话。

结尾

如果你经常在 DSH 里写插件,dsh-plugin-dev-kb 的价值在于把官方文档和仓库补充资料放到 agent 可直接读取的位置。安装后做一次手动挂载,新会话里就可以按主题导航定位文档,再按需读取具体文件。

GitHub 仓库见:

https://github.com/Pasumao/dsh-plugin-dev-kb

羽毛球分组比赛记分
小程序二维码

欢迎使用《羽毛球分组比赛记分》微信小程序

Xiaoye