前言¶
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