Back to home@zhangzhend0ng

canonkeeper

canonkeeper —— 网文长篇设定冲突验证 harness:状态库 + 纯程序化规则引擎 + MCP server,作为 dsh (deepseek-harness) 插件

Stars
0
Language
Python
Created
Sep 7, 2026
Updated
Sep 7, 2026
GitHub repo

Introduction

canonkeeper —— 网文长篇验证 harness

给长篇网文的生成/改稿流程装上三级验证体系。模型无关(OpenAI 兼容 API 可插拔), 研究"怎么用模型",不练模型——模型是可插拔的被试,harness 是资产。

方案全文见 PLAN.md(v1,2026-09-07)。

书稿 txt → 切章 → [抽取器] LLM 结构化输出 → [状态库] SQLite
         → [规则引擎] 纯程序化不变量检查(不调 LLM,零幻觉)
         → [软验证器 M2] persona 读者 → [报告] markdown 冲突清单

关键设计:硬验证器的"判定"环节不经过 LLM——LLM 只负责抽取,判定可复现、可单测、无幻觉。 规则引擎的谓词是纯函数,100% 单测覆盖(tests/)。

安装

python -m venv .venv
.venv/Scripts/pip install -e ".[dev]"      # Windows;Linux/macOS 用 .venv/bin/
.venv/Scripts/pytest                        # 75 项单测,全部离线

命令行入口:canonkeeper(主)、canonkeeper-mcp(MCP server)。dsh 仅作遗留别名保留—— deepseek-harness 的 CLI 也叫 dsh,同环境安装会撞名。

配置(密钥只走环境变量,绝不写入代码/配置/日志)

provider环境变量fast 档flagship 档
deepseek(默认)DEEPSEEK_API_KEYdeepseek-chatdeepseek-reasoner
glmZHIPU_API_KEYglm-4-flashglm-4-plus
mock(离线冒烟)

模型名可用 DSH_FAST_MODEL / DSH_FLAGSHIP_MODEL 覆盖(上游改名零代码适配)。 分级调用策略:fast 档做批量抽取,flagship 档留作终审/复核。

用法

canonkeeper ingest book.txt --db books/demo.db --provider deepseek [--limit 10] [--skip-errors]
canonkeeper check   books/demo.db                  # 规则引擎,冲突写回状态库
canonkeeper report  books/demo.db                  # markdown 冲突报告 → reports/
canonkeeper replay  books/demo.db 3                # 回放第3章抽取 JSON(往返核对)
canonkeeper stability book.txt --provider deepseek --runs 2  # M0 验收:抽取往返稳定性
canonkeeper rules                                  # 列出内置规则

无 API key 时可用 --provider mock 跑通全链路(返回与正文无关的固定样例抽取)。

内置规则(M1 起步集,PLAN §4 20 条中的可机检子集)

规则检查谓词
CHAR_001死亡后不得以活体出场(复生须登记)terminal_state_reuse
ITEM_009已毁/已耗品不得复用(修复/复得须登记)terminal_state_reuse(同谓词异参数)
CHAR_012境界单调(废功须登记;阶梯前缀匹配,阶梯外值跳过不误报)realm_regression
CHAR_002年龄等数值属性随时间线单调(重生/回溯须登记;支持中文数字)numeric_attr_monotonic
CHAR_005位置连续性(瞬移须登记;依赖事件 location,缺失自动跳过)location_continuity
ITEM_011交易/赠予后所有权转移须登记(前后 window 章内查登记)transfer_registered
TIME_006故事时间单调(闪回须显式标记;依赖 day_offset,缺失自动跳过)time_regression
META_018别名归一(别名指向多实体 → info,人工裁决)alias_collision

加规则零代码:写一个 YAML(rule_id/name/severity/predicate/params),canonkeeper check --rules your.yaml。 境界阶梯等参数按书自定义,示例见 examples/custom_rules.yaml。 PLAN §4 二十条中余下 12 条(称谓一致性、金钱流水守恒、数字复述一致、代词指代…) 需要更强的抽取契约支撑,按里程碑逐步补谓词。

作为 dsh(deepseek-harness)插件接入(MCP)

deepseek-ai/deepseek-harness(CLI 名 dsh, "everything is a plugin")的插件一等公民是 TypeScript/Cordis;Python 工具包的标准接入路径是 MCP server。本仓库内置两端:

  • MCP servercanonkeeper/mcp.pypip install "canonkeeper[mcp]" 后由 canonkeeper-mcp 启动), 工具面对应 PLAN M3 生成回路:

    工具时机作用
    ingest_book写后切章 + LLM 抽取 + 入库
    check_consistency写后规则引擎冲突清单(JSON,纯程序化判定)
    query_entity写前按名/别名查实体属性、状态史、关系、出场章
    replay_chapter复核回放某章抽取 JSON,定位误报来源
    get_report复核markdown 冲突报告全文
  • dsh bundleplugin/):薄壳,只插一行 @deepseek-ai/dsh-mcp-client 配置。 安装:dsh plugin --profile <name> add file:<repo>/plugin,工具即以 mcp__canonkeeper__* 出现在模型工具列表。详见 plugin/README.md

当前状态

  • M0 完成(含真实 API 基线,2026-09-07):provider 层(deepseek/glm/mock + 分级档位)、 切章、抽取管线(错误反馈重试 ×1、--skip-errors 降级)、SQLite 状态库、stability 验收工具。 真实基线(deepseek-chat,用户自有书稿 3 章):ingest→check→report 全链路通过, 13 实体 / 4 状态变更入库,别名归一(浮窗→豆包、新手村→艾尔村)正确; 往返稳定性(别名集 Jaccard,runs=2)全书均值 0.651(分章 0.889 / 0.778 / 0.286, 第 3 章偏不稳,事件/变更计数同步波动)。改进抓手:抽取降温、双遍抽取交叉 + 旗舰复核(PLAN §8)。glm 适配器未实测(环境无 ZHIPU_API_KEY)。
  • M1 起步:规则引擎 + 8 条内置规则 + 报告。真实书稿 3 章检出 0 冲突(新稿无既有矛盾, 亦无为凑数的误报)。计划 20 条中其余谓词逐步接入。 自定义规则示例:canonkeeper check books/demo.db --rules examples/custom_rules.yaml
  • M2 占位:persona 契约与内置画像已定义(readers/personas.py),模拟实现待 M2。
  • dsh 插件接入(MCP):server + bundle 完成,stdio 端到端测试覆盖;真实 dsh 运行时 plugin add + --dump-config 层叠加验证通过(工具注册的启动级验证待 LLM 凭据)。
  • 重建策略:rebuild() 以全书抽取为事实源单事务全量重建;增量追章优化留后续里程碑。

工程约定

  • 异常策略:统一异常;层边界翻译为 ProviderError/ExtractionError/RuleError 并附上下文;CLI 顶层统一打印一次错误(--debug 看栈)。
  • LLM 输出与规则 YAML 一律按不可信输入处理:pydantic 严格验证 / yaml.safe_load
  • API key 只从环境变量读取;任何错误消息与日志不含密钥。
  • 文稿版权:只处理用户自有/公版文稿,不内置任何平台抓取。