Skills

Kb Retriever

面向本地知识库目录的检索和问答助手。核心流程:(1)分层索引导航 (2)遇到PDF/Excel时必须先读取references学习处理方法...

Install

npx skills add ConardLi/garden-skills --skill kb-retriever -g -a claude-code -y
Repository
ConardLi/garden-skills13.5k
Category
Data and ML
Updated
10d ago
License
MIT
Context cost
Mediumabout 1,684 tokens
Runs scripts
Yes, review before use

What it does

面向本地知识库目录的检索和问答助手。核心流程:(1)分层索引导航 (2)遇到PDF/Excel时必须先读取references学习处理方法 (3)处理文件后再检索。按文件类型组合使用 grep、Read、pdfplumber、pandas 进行渐进式检索,避免整文件加载。用户问题涉及"从知识库目录回答问题/检索信息/查资料"时使用。

本地知识库检索 Skill(kb-retriever)

知识库目录说明

  • 知识库存放在一个根目录下,包含多种文件类型(如 .md/.txt、.pdf、.xlsx 等),通常按类型或业务用途拆分为多级子目录。
  • 采用分层目录索引文件:
    • 根目录有一个 data_structure.md,说明主要的「领域目录」及其用途。
    • 每个领域目录下可以有自己的 data_structure.md,说明该目录下有哪些子目录/文件,以及各自用途。
    • 更深一层的子目录也可以继续有 data_structure.md,形成多级索引树。
  • 知识库根目录约定:
    • 默认认为知识库位于当前项目根目录下的 knowledge/ 目录。
    • 如果用户在对话中明确指定了其他路径(例如“我的知识库在 /data/kb”或“用 ./docs 这个目录作为知识库”),则以用户指定的路径作为根目录。
    • 当默认路径 knowledge/ 不存在或访问失败时,应向用户确认实际的知识库根目录位置,而不是随意猜测。
  • 单个业务文件可能很大:
    • 不要直接用 Read 读取整文件
    • 对 PDF、Excel 使用对应 Skill 进行结构化处理后,再结合 grep/局部读取做精细检索

定位 knowledge 根目录

  • 根目录优先听用户:如果用户给了路径(如 ./docs、./knowledge-personal),直接用用户提供的路径。
  • 默认根目录:否则约定根目录为当前项目下的 knowledge/。
    • 使用 shell 显式检查目录是否存在:优先使用 test -d knowledge,或退而求其次使用 ls -d knowledge。
    • 注意:禁止使用 Glob "knowledge" in . 这类模式来判断目录是否存在,Glob 只返回文件路径,不返回目录本身,空结果并不能区分“目录不存在”和“目录存在但为空”。
  • 只有在根目录已通过 test -d 等方式确认存在时,才使用 Glob 在该目录下检索内容,并把目录作为 path,例如:
    • 索引文件:pattern="**/data_structure.md", path="knowledge"
    • 所有 Markdown:pattern="**/*.md", path="knowledge"
  • 如果默认 knowledge/ 不存在(test -d 失败):不要猜测其他目录,明确告诉用户未找到默认根目录,并让用户指定实际知识库路径。

关键原则:先学习,再处理

遇到 PDF 或 Excel 文件时的强制检查清单:

  • ✅ 已读取对应的 references 文档学习处理方法
  • ✅ 已理解推荐的工具和命令
  • ✅ 已将文件处理(提取/转换)完成
  • ⏭️ 现在可以开始检索

禁止行为:

  • ❌ 在未读取 pdf_reading.md 的情况下直接尝试处理 PDF
  • ❌ 在未读取 excel_reading.md 的情况下直接尝试处理 Excel
  • ❌ 跳过文件处理步骤,直接对原始 PDF/Excel 进行检索

总体流程

  1. 理解用户需求
    • 读用户问题,提取:
      • 主题/领域关键词(如“销售报表”“系统架构”“接口文档”)
      • 时间或范围限定(如“2023 年 Q1”“最近版本”)
      • 需要的输出类型(解释、摘要、具体字段数值等)
    • 确定知识库根目录:
      • 优先检查用户是否在问题中指定了知识库路径。
      • 否则使用默认根目录 knowledge/。
      • 若默认根目录不存在或目录结构异常,应向用户询问确认,而不是自行假设。
Read the whole SKILL.md on GitHub

More in Data and ML