知识库

本地知识库检索 Skill（kb-retriever）

知识库目录说明

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

定位 知识库 根目录

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

关键原则：先学习，再处理

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

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

禁止行为：

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

总体流程

1. 理解用户需求

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

2. 分层查看目录索引 index.md

   • 使用一个「当前工作目录」的概念：
     • 默认从用户指定的知识库根目录开始；如果用户未指定，则使用当前目录。
   • 在当前工作目录下，如果存在 index.md 或 moc.md：
     • 使用 Read 读取该文件的前若干行（例如 limit=300），必要时分段继续读取。
     • 目标：
       • 了解当前目录下有哪些子目录和文件
       • 理解每个子目录/文件的用途说明
     • 基于用户问题，挑选最相关的若干个子目录或文件，构成候选集合。
   • 对于候选子目录：
     • 递归进入该子目录，将其作为新的「当前工作目录」，继续查找其中的 index.md 并重复上述过程。
     • 在递归过程中，避免一次性深入所有分支，优先沿着与问题最相关的路径向下钻取。
   • 对于候选业务文件（md/文本、PDF、Excel 等）：
     • 在完成必要的目录层级探索后，收集这些文件为最终的检索目标列表。
   • 在优先级排序时：
     • 优先选择用途说明与问题主题高度匹配的领域目录和文件
     • 其次考虑时间/版本等约束（如果索引中有体现）
     • 通用说明类文档（如 README.md、总体设计类文档）放在较后优先级