文档
文档放在 YuCe 的代码仓库中,这样只有一个信息来源。可以从下面这些地方开始。
在你自己的文件夹上:一个智能体
一个存放 UTF-8 文本文件的文件夹,一个问题,一个智能体。在 MCP 客户端的配置中加入一项(Claude Code 的 .mcp.json、Claude Desktop、Cursor,或任何通过 stdio 启动服务器的客户端),填上你的目录路径:
- 发布页上的
yuce二进制文件(核对它的 SHA-256 校验值);sbgk是同一个程序。 - 一个存放 UTF-8 文本文件的文件夹(PDF 和 Word 请先转成文本)。
- 你的问题,写在
--ask之后。
客户端自己运行的命令:
yuce mcp --docs /path/to/my-docs --ask "这些文档关于退款说了什么?" --about "退款,退货"或者作为 MCP 客户端配置中的一项:
{"mcpServers": {"yuce": {"command": "yuce", "args": ["mcp", "--docs", "/path/to/my-docs",
"--ask", "这些文档关于退款说了什么?", "--about", "退款,退货"]}}}客户端会自行启动服务器:不需要另外运行任何程序,也不需要复制令牌。第一次启动会读取这个文件夹,并把日志保存在 my-docs/.yuce/run.wal;再次启动时继续同一次运行。你的智能体得到阅读智能体的工具,以及你作为所有者的阅读工具,其中 audit_withdraw_preview 只显示一次撤回会让哪些内容失去依据,不写入日志。会写入的工具(撤回文本、关闭这次运行)默认不对模型开放,用 --owner-tools all 启动服务器才会开启。过长的工具结果分段返回,因为 MCP 客户端会限制单个工具结果的大小,用 audit_more 读取其余部分。主题词来自问题本身;可以用 --about "退款,退货" 自己给出,中文和日文的问题需要这样做。
所有者撤回一段文本之后,下面的命令会列出什么失去了依据:
sbgk audit-read fallen --wal my-docs/.yuce/run.wal自己运行服务器,让更多智能体可以加入:
cat > questions.json <<'EOF'
[{"id": "q1", "text": "What do these documents say about refunds?", "about": ["refund"]}]
EOF
sbgk audit-serve --profile solo --docs ./my-docs --questions questions.json --run-id mine --wal mine.wal --listen 127.0.0.1:8787--profile solo 运行一个读取智能体,不带图构建器。不指定 --subjects 时,服务器会在日志旁写出 mine.wal.subjects.json,里面有两个令牌:agent 给你的智能体,owner 给你自己,且从不打印它们。让你的客户端以 agent 身份加入:--agent-id agent,令牌放在 SBGK_MCP_TOKEN 中;桥接配置见 README。一次运行在启动时固定它的文件:文件一旦改变,就是一次新的运行。
从这里开始
- README
内核做什么、不做什么,测试结果,快速开始和名字的由来(英文)。
- 快速开始
Linux、macOS 和 Windows 的发布版,Python 客户端,以及一个最小示例(英文)。
- 在开放语料上运行审计服务
如何在开放语料上,或用
--docs在你自己的文档上启动sbgk audit-serve(英文)。 - 简体中文 README
简体中文版的 README。
参考
- LIMITATIONS.md
内核不做什么、不展示什么、以及有代价的部分(英文)。
- BENCHMARKS.md
测了什么、在什么上测、由谁测,以及有哪些保留(英文)。
- SECURITY.md
审计服务的信任模型,以及如何报告安全漏洞(英文)。
- CHANGELOG.md
每个版本的变更(英文)。
- 审计层
关于内核审计层的更多说明(英文)。
示例
- examples/revoke-and-replay
一分钟演示,附可离线查看的检查页面。
- examples/quickstart
引擎的最小示例:两条引用、两条事实、一次推导。
- examples/findings-gate
安全审查对代码文件所得发现经由内核的示例。
- examples/live-journal
YuCe Live:由一份日志生成的一个 HTML 页面,逐帧回放(英文)。
- examples/prov-export
把日志写成 W3C PROV-O,附一个示例(英文)。
安装
- 发布页
Linux、macOS 和 Windows 的二进制文件及 SHA-256 校验值。运行 sbgk --help(或 yuce --help,是同样的命令)。
- PyPI 上的 Python 客户端
用
pip install organetic-yuce安装,导入时写yuce。它是服务器工具的轻量客户端。 - clients/python
Python 客户端的源码和 README。
PyPI 上的 yuce 属于另一个无关的项目:请安装 organetic-yuce。
0.2 新增
0.2 系列的新增内容(0.2.0,2026 年 11 月 12 日;0.2.1,2026 年 11 月 14 日;0.2.2,2026 年 11 月 15 日):
一个智能体,一行配置
yuce mcp --docs <文件夹> --ask <问题> 是一个由 MCP 客户端自行通过 stdio 启动的 MCP 服务器。它启动或继续一次运行,把日志保存在 <文件夹>/.yuce/run.wal,这次运行的两个令牌由它自己保管。过长的结果分段返回。
什么失去了依据,以及原因
sbgk audit-read fallen --wal run.wal 列出每条失去依据的记录、被撤回的引用(按字节,而不是按文本)及原因、其下仍然有效的引用、其他来源上意思相近的结论,以及应当重新阅读的位置。撤回之前也能得到同样的报告:audit_withdraw_preview 显示一次撤回会让哪些内容失去依据,且不写入任何内容。
单条结论的凭证
sbgk audit-proof 为一条记录及其全部依据(直到引用本身)切出一个文件,置于签名检查点之下;在对照运行中为 7–24 KB。sbgk audit-proof-verify 无需日志、无需模型即可单独核验它。
任何人都能核验的日志
用签名密钥启动的服务器会为日志的检查点签名(C2SP signed note,Ed25519)。sbgk audit-verify 用保存在别处的回执或检查点核验日志。核验始终免费。签名只证明密钥的持有者这样声明过:请把检查点保存在日志写入者无法修改的地方。
没有任何内容被静默跳过
sbgk audit-read coverage 根据日志、无需模型,说明文档中每个列表项、段落和表格行的结果:已被引用(由哪些记录引用)、因阅读预算未覆盖、被撤回,或未读。补漏阅读(--gap-pass,默认关闭)可以把没有引用覆盖的部分作为窄任务重新分给智能体。
日志旁的索引与来源记录
sbgk audit-index 生成任何工具都能读取的 SQLite 文件;sbgk audit-prov 把日志写成 W3C PROV-O,一个任何 RDF 工具都能读取的 JSON-LD 文件:每条记录由谁写下、立足于哪个文档版本的哪些字节、依据什么,以及何时成立、何时不再成立。两者都可随时由日志重建。
