docs-search

Installation
SKILL.md

docs-search 文档检索

企业内部库文档检索:一个通用技能覆盖全部已收录库,动态发现,不做每库一技能。

需要内部库事实时,直接运行本技能内嵌脚本,不要凭训练数据猜测私有 API。

脚本:scripts/query.mjs(Node ≥ 24,零依赖)。命令一律在用户仓库根目录执行.env 所在处):脚本路径写成指向本技能的绝对路径,--env-file=.env 相对当前目录解析、才能命中仓库根的 .env;不要 cd 进技能目录再跑。服务地址只读环境变量 DOCS_SERVER_URL(结尾斜杠由脚本去掉);落盘只允许仓库根目录 gitignore 过的 .env,禁止写进本技能、代码或会提交入库的配置。

流程

1. 检测环境变量(始终第一步)

运行任何查询前,先检查进程环境变量 DOCS_SERVER_URL(按宿主 shell 语法:POSIX 用 printenv,PowerShell 用 $env:DOCS_SERVER_URL),并读当前仓库根目录 .env,两处任一有值即算已配置。

  • 已配置:直接进入第 2 步。值来自 .env 时,命令写成 node --env-file=.env <脚本绝对路径> …--env-file 是 Node 内置参数,Windows/macOS/Linux 通用,禁止用 set -a && source 等 POSIX 专属前缀。
  • 缺失:引导用户补齐:
    1. 用提问工具向用户询问服务地址(向文档服务管理员索取,形如 http://docs.internal:8080);禁止编造或猜测地址。
    2. 写入当前仓库根目录 .env(已存在则只补缺失行,不覆盖已有值)。格式:DOCS_SERVER_URL=<地址>= 两侧不留空格。
    3. 确认 .gitignore 已含 .env;没有则追加。
Installs
5
First Seen
3 days ago
docs-search — cabinet-fe/prompt-engineering