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

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

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

小夜