前言¶
DeepSeek Harness(DSH)採用插件化架構,其生態系統中的插件倉庫通常缺乏 AI 智能體優先查找的 llms.txt 文件。當智能體進入倉庫時,llms.txt 是理解項目結構和關鍵信息的最快入口。dsh-llms-forge 插件旨在解決這一問題,它從 package.json 和 README.md 中提取數據,確定性生成符合 llms.txt 規範的發現文件。
這是什麼¶
dsh-llms-forge 是一個由 zoahdev 維護的 DSH 插件,用於爲 DeepSeek Harness 插件倉庫自動生成 llms.txt。它是一個零運行時依賴的命令行工具,同時也支持在 Harness 內部被 Agent 調用。
插件默認以只讀模式運行,確保在未顯式開啓寫入權限前不會修改本地文件。生成的文件內容包含標題(來自包名)、摘要(來自 description 或 README 第一段)以及安裝命令、許可證、主頁、關鍵詞、入口點等關鍵事實。
核心功能¶
- 自動生成:讀取
package.json和README.md,自動提取元數據生成llms.txt。 - AI 可讀:輸出符合
llms.txt規範的格式,便於 AI 智能體快速發現和索引。 - 零運行時依賴:工具本身不依賴複雜的運行環境,安裝和使用簡單。
- CLI 工具:提供標準的命令行接口。
- Agent 可調用:支持在 Harness 內部通過工具調用方式使用。
- 安全可控:默認只讀,寫入操作需通過
--write和--overwrite顯式開啓。 - 可復現與 CI 友好:生成結果可復現,支持 JSON 輸出和退出碼檢查,適合集成到 CI 流程中。
安裝與啓用¶
在 DSH 環境中安裝此插件,使用官方命令:
dsh plugin add dsh-llms-forge
安裝完成後,既可以在 Harness 內部調用,也可以作爲獨立 CLI 工具運行:
npx dsh-llms-forge .
典型用法¶
命令行使用¶
插件提供以下 CLI 參數:
dsh-llms-forge [dir] [--write] [--overwrite] [--json]
常用示例:
- 打印預覽(默認只讀,不寫入文件):
npx dsh-llms-forge .
- 寫入文件:
npx dsh-llms-forge . --write --overwrite
- JSON 格式輸出:
npx dsh-llms-forge ./my-plugin --json
在 Harness 內使用(Agent 調用)¶
在 Harness 的交互式環境中,可以通過調用 llms_forge 工具來生成文件。Agent 需要設置 dir(目錄)和寫入選項:
- 目錄設置:指向目標插件倉庫根目錄。
- 寫入選項:設置
write: true和overwrite: true。
工具返回 dsh-llms-forge/v1 格式的結果,包含生成的內容和警告信息,僅在 options.write 爲 true 時執行寫盤操作。
適用場景與注意¶
- 維護現狀:手寫的
llms.txt容易與源碼不同步,本插件生成的文件由代碼確定,便於維護。 - CI 檢查:利用
--json輸出和退出碼(0 清理,1 警告,2 錯誤)可在 CI 流程中進行檢查。 - 權限檢查:安裝前請檢查源碼與許可證(MIT),確保符合本地環境要求。
- 環境要求:需要 Node.js 版本 >= 18。
- 數據源:生成內容嚴格基於
package.json和README.md。
結語¶
dsh-llms-forge 解決了 DSH 生態中插件缺少 AI 發現文件的問題,通過確定性生成確保了文檔的準確性和可維護性。對於開發者而言,這是接入 AI 生態、提升插件可發現性的基礎工具。
- 插件目錄:dsh-llms-forge
- GitHub 倉庫:zoahdev/dsh-llms-forge