PROJECT NOTES / CHILON RECALL

Chilon Recall

让自己的资料,变成可以被追问、比较与复习的本地知识库。

Chilon Recall 是 Chilon 产品线中专注于本地检索的独立项目:把文本资料转换为私有、 来源可追溯的知识库,再通过 stdio MCP 交给本地 AI 客户端使用。

当前公开版本为 v0.1.5,已发布到 npm:npx -y chilon-recall@0.1.5 install 一条命令即可创建私有配置并安装受管 Python engine;也可以把 AGENTS_INSTALL 手册交给 AI coding agent 代为安装。

基于内容哈希的增量索引 rag_sync 与 Qoder 客户端适配已在 v0.1.3合并发布,v0.1.4 加入了在线确认 Key 的向导。Windows 上 npx 偶发无法识别命令的问题 目前无法复现,但原因尚未查明,仍记为已知问题。

公开版本 v0.1.5 · 增量索引 / Qoder 适配 / Key 向导

先回答资料说了什么,再讨论还能推断什么。

Chilon Recall 将自己的 Markdown、TXT、RST 与 CSV 资料建立为本地知识库,回答问题时保留 相对来源路径、标题层级、近似行号和检索分数,让“答案来自哪里”可以继续被检查。

它同时服务直接检索和学习工作流:可以从笔记或报告找回论据,也可以基于课程资料做教材问答、 概念比较、章节总结与复习提纲。它与 Chilon Knowledge Work Harness 保持独立,前者负责本地检索, 后者负责更广泛的长期知识工作编排。

检索、学习工作流和安全操作各自承担清楚的职责。

本地资料Markdown / TXT / RST / CSV
当前版本面向 UTF-8 文本资料,文档与索引保留在本机,适合把个人笔记、课程材料和研究资料放进同一套检索流程。
安装方式npx chilon-recall@0.1.5 install
一条命令即可在资料目录写入私有配置,并在用户数据目录安装受管 Python engine;install、setup、doctor、key、mcp 都由同一个 Node.js CLI 提供,凭据始终只放在环境变量中。也可以把 AGENTS_INSTALL 手册交给 AI coding agent 代为安装,输入 API Key 这一步刻意留给用户本人。
Key 向导chilon-recall key
以隐藏输入读取一次 provider Key,调用该 provider 自己的 /models 接口在线确认地址与 Key 是否可用,并推荐 embedding 与 reranker 模型;Key 只用于这一次请求,不写入任何文件。
检索底座FAISS + JSON metadata
资料经过标题感知分块后建立本地 FAISS 索引,并保留相对来源路径、标题层级、近似行号与检索分数。
增量索引rag_sync
manifest 记录每个文件的 SHA-256 与建库参数:资料变更后,未改动文件直接复用已有向量,只对新增、修改与删除的文件做对账;建库参数变化或 manifest 过旧时自动回退全量重建。rag_build 保留为刻意的全量重建入口。
学习入口rag_query / textbook_qa / review_outline
除了直接找回论据,也提供教材问答、概念比较、章节总结与复习提纲等面向学习的结构化入口。
MCP host 与引擎Node.js CLI / Python engine
Node.js CLI 与 MCP host 提供 init、setup、doctor、mcp 入口,并负责配置、路径安全、备份和客户端工具;Python engine 负责分块、provider 调用、索引序列化与检索。
DeepSeek Harness 适配DSH bundle + stdio bridge
已随 v0.1.2 合并进 main:通过 @deepseek-ai/dsh-mcp-client bridge 启动现有 CLI MCP server,使工具以 mcp__chilon-recall__* 名称暴露;不重复运行检索引擎,凭据继续通过环境变量传递。当前 bundle 只转发 RAG_MANAGER_CONFIG、RAG_API_KEY、RAG_RERANK_API_KEY、CHILON_RECALL_HOME 与 CHILON_RECALL_PYTHON,且 DSH 自身仍属于 developer preview。
Qoder 适配chilon-recall qoder <directory>
从同一套 stdio server 与内置 skills 生成 .qoder/mcp.json、项目级 skills 与检索 rule,不重复实现检索引擎,生成的文件不含凭据;mcp.json 是一份需要粘贴进 Qoder 客户端设置的配置片段,从 npx 临时缓存运行时会提示路径不稳定。
可恢复操作preview → confirmation token → execute
建库、增量同步、清理与恢复先生成预览,再用短期确认 token 执行;active index 的替换与备份都保留明确的操作边界。

进度记录

每条内容保留日期
  1. 发布 v0.1.5:AI agent 安装手册,npx 问题如实记录为未解决

    新增中英双语 AGENTS_INSTALL 手册,让 Claude Code、Codex CLI 等 AI coding agent 可以照着完成安装与配置;输入 API Key 这一步刻意交还给用户,不经过 agent 的 shell 或上下文。按手册实际走一遍后,补上了此前遗漏的 RAG_MANAGER_CONFIG 设置步骤。另外,v0.1.4 曾在 Windows 上出现 npx 报 “'chilon-recall' is not recognized” 的问题,2026.09.21 已无法复现,但原因仍未查明,这一版不包含修复,CHANGELOG 将其记为未解决的已知问题并给出绕行方式。

    查看对应提交
  2. 发布 v0.1.4:Key 向导与一组可靠性修复

    新增 chilon-recall key:隐藏输入一次 provider Key,调用 provider 的 /models 接口在线确认,并推荐 embedding 与 reranker 模型,Key 不写入磁盘。同时修复 doctor 把模板占位值误报为就绪、CLI 退出码始终为 0、粘贴带换行的 Key 时卡死、异常信息中泄露明文 Key、把 reranker 误推荐为 embedding 模型、base_url 后缀被重复拼接等问题,并让首次安装 Python engine 时输出进度,而不是静默运行。

    查看对应提交
  3. 发布 v0.1.3:增量索引 rag_sync 与 Qoder 适配合并发布

    agent/incremental-sync 与 agent/qoder-compat 两条分支经 PR #5、#6、#7 合并进 main,并随 v0.1.3 发布到 npm:rag_sync 用内容哈希复用未改动文件的向量,chilon-recall qoder 生成 Qoder 客户端所需的 mcp.json、skills 与 rules。同一天,README 拆分为英文与简体中文两份结构一致的独立文档(PR #8),并升级传递依赖以通过 CI 的 npm audit 检查。

    查看对应提交
  4. 增量索引与 Qoder 适配进入开发分支

    agent/incremental-sync 分支加入基于内容哈希的 rag_sync:manifest 记录每个文件的 SHA-256 与建库参数,未改动文件直接复用向量,只对新增、修改与删除的文件做增量对账,参数变化或 manifest 过旧时自动回退全量重建,并沿用 rag_build 既有的 preview / execute 与 staged swap 流程。agent/qoder-compat 分支则从同一套 stdio server 和内置 skills 生成 Qoder 所需的 mcp.json、skills 与 rules。两条分支已于 2026.09.18 合并进 main,随 v0.1.3 发布。

    查看对应提交
  5. README 改为新手优先结构

    把双语 README 重新组织为“先三步跑通、再讲配置细节”的顺序:先给出安装、设置 provider key 与连接一个客户端的最小路径,客户端配置、工作原理、工具边界与已知限制移到后文,降低第一次接触 MCP 的门槛。

    查看对应提交
  6. 发布 v0.1.2:npm 一条命令安装,DSH 适配合并进 main

    npm 发布 chilon-recall v0.1.2,npx -y chilon-recall@0.1.2 install 一条命令即可创建私有配置并安装受管 Python engine;DeepSeek Harness bundle 经 PR #2 合并进 main,不再只存在于开发分支;同时修复 Windows 文档路径规范化问题。

    查看对应提交
  7. 加入 DeepSeek Harness bundle(开发分支)

    在 agent/dsh-harness-plugin 分支加入 dsh/cordis.patch.yml,通过 @deepseek-ai/dsh-mcp-client bridge 复用现有 stdio MCP server;工具以 mcp__chilon-recall__* 名称暴露,不重复运行检索引擎,凭据继续通过环境变量传递。同时补齐 Node.js CLI 的 init / setup / doctor / mcp 入口与隔离 Python engine 管理。该分支已于 2026.08.26 合并进 main。

    查看对应提交
  8. 发布 v0.1.0 初始版本

    完成本地优先 MCP knowledge engine、来源可追溯检索、学习工作流、分阶段建库与可恢复备份,并加入 Codex plugin、Claude Desktop/Codex 配置指南和 npm/npx CLI。

    查看对应提交
  9. 补齐中文文档与双语 README

    让项目定位、快速开始、MCP 客户端配置、工作原理、工具边界、数据安全与已知限制都能在仓库中直接阅读。

    查看对应提交

已完成与计划中

已完成

  • 来源可追溯的本地检索
  • 教材问答、概念比较、章节总结与复习提纲入口
  • 分阶段建库与可恢复 backup / restore
  • Codex plugin 与 stdio MCP 配置
  • Node.js CLI 与独立 Python engine
  • npx 一条命令安装与受管 Python engine
  • DeepSeek Harness bundle 适配(已合并 main)
  • 基于内容哈希的增量索引 rag_sync(v0.1.3)
  • Qoder 客户端适配(v0.1.3)
  • Key 向导 chilon-recall key(v0.1.4)
  • 面向 AI coding agent 的安装手册(v0.1.5)
  • npm 发布 v0.1.5

计划中

  • 迁移到 MCP SDK v2(Issue #4 跟踪中)
  • 查明 Windows 上 npx 偶发 “not recognized” 的原因
  • 带覆盖报告的 PDF 提取与 OCR adapter
  • 本地 embedding 与 reranking provider
  • 来源过滤与 collection namespace
  • 检索质量与引用覆盖评估样例