@my-life-buddies/buddy-runtime 0.15.0 → 0.17.0

package/README.md

@@ -20,7 +20,7 @@ npm install @my-life-buddies/buddy-runtime typebox
 
 ### 1.2 创建搭子
 
-通过 `@my-life-buddies/cli` 完成搭搭账号注册，并创建一个新的搭子，获取 buddyId & buddyToken
+通过 `@my-life-buddies/cli` 完成搭搭账号注册，并创建一个新的搭子，获取 buddyId 与开发令牌（平台另有一把正式令牌，只在托管运行时注入，不经 CLI 下发）
 
 ### 1.3 搭子工程框架
 
@@ -49,48 +49,27 @@ const planMenu: AgentTool<typeof PLAN_MENU_PARAMS, undefined> = {
 	}),
 };
 
-await BuddyServer.start({
-	buddyId: process.env.BUDDY_ID!,
-	token: process.env.BUDDY_TOKEN!,
-	dataRequirements: [],
-	buddy: () => ({
-		initialState: {
-			model: "kimi-k3",
-			systemPrompt: "你是「小涂阿姨」——一位管做饭的阿姨……",
-			tools: [planMenu],
-		},
-	}),
-});
+await BuddyServer.start(() => ({
+	initialState: {
+		model: "kimi-k3",
+		systemPrompt: "你是「小涂阿姨」——一位管做饭的阿姨……",
+		tools: [planMenu],
+	},
+}));
 ```
 
-完整示例：[examples/aunt-tu/](examples/aunt-tu/)（提问、记忆、小挂件）、[examples/cardio/](examples/cardio/)（授权数据、主动服务、提问、记忆、小挂件）。
-
 ## 2. 配置
 
-### 2.1 `BuddyServer.start(options)`
+### 2.1 `BuddyServer.start(buddy)`
 
 连上平台开始处理消息，返回 `{ stop(): Promise<void> }`。
 
-```ts
-interface StartOptions {
-	// 必填。搭子 id 与令牌，注册时平台分配，见 1.2。平台托管时以环境变量 BUDDY_ID、BUDDY_TOKEN 注入
-	buddyId: string;
-	token: string;
-
-	// 必填。这只搭子需要的用户数据及用途，见 3.4；不需要时传 []
-	dataRequirements: { id: DataAccessDatasetId; purpose: string }[];
-
-	// 必填。每场会话建起来时调一次，返回这场会话的配置，见 2.2、2.3
-	buddy: (conversation: Conversation) => BuddyOptions | Promise<BuddyOptions>;
-}
-```
+`buddy` 是每场会话建起来时调用一次的工厂函数，返回这场会话的配置，见 2.2、2.3。DataAccess 声明不属于会话工厂，单独写在工程根目录的 `data-access.json`，见 3.4。
 
-Runtime 启动时只在本地校验 `dataRequirements`，不会额外调用接口注册声明。Runtime 根据自身导出的能力目录补齐标题、来源和 Schema 版本；实际调用 `data_access_query`、发送 HealthKit 权限卡或申请使用数据的主动服务时，会把完整声明随业务请求携带给平台。平台在该次请求中更新用途版本并校验 Grant。
+**buddyId 与 token**：Runtime 会从环境变量 `BUDDY_ID`、`BUDDY_TOKEN` 读。创建搭子时会下发 buddyId 与开发 token，本地开发时，启动命令携带环境变量，正式上线时平台托管会注入同名变量，token 会切换成正式 token，对开发者无感。
 
 **buddy 的生命周期**：`buddy` 在每场会话收到第一条消息时调用一次。会话空闲 30 分钟被回收、或进程重启后，下一条消息会重新调用，所以闭包里的变量不能当长期存储，需要存储会话状态可以根据场景使用 3.3 记忆、3.5 小挂件实现。
 
-**同一时间只有一个进程**：同一个搭子身份同一时间只有一个进程连着平台，本地调试用的 `<buddyId>-dev` 也一样。新进程连上平台后，原来那个进程会打一条 ERROR 日志说明被顶掉，然后退出、不再重连。本地不小心起了多个进程时，留下的是最后连上平台的那个。
-
 **buddy 的会话压缩**：会话历史长到一定程度时，运行时在会话被回收后把早先的对话压成一份摘要写回平台，下次重建时模型看到的是「摘要 + 最近的原文」。开发者不用做任何事，也没有开关。
 
 ### 2.2 `BuddyOptions`
@@ -209,16 +188,17 @@ interface Conversation {
 		send(id: string, options: { idempotencyKey: string }): void;
 	};
 
-	// 主动服务，见 3.6：propose 提订阅，平台建成即生效；isRunning 判断现在是不是主动服务的回合
+	// 主动服务，见 3.6：按稳定 key 订阅、查询和关闭；isRunning 判断现在是不是主动服务的回合
 	proactive: {
-		propose(request: ProactiveSubscriptionRequest): Promise<{ id: string; status: "active" }>;
+		subscribe(key: string, request: ProactiveSubscriptionRequest): Promise<ProactiveSubscription>;
+		list(): Promise<ProactiveSubscription[]>;
+		unsubscribe(key: string): Promise<boolean>;
+		unsubscribeAll(): Promise<number>;
 		isRunning(): boolean;
 	};
 }
 ```
 
-`tools`、`memory`、`dataAccess`、`widget`、`proactive` 已经绑好这场会话，直接用，不用传令牌或拼接口路径。
-
 ## 3. 平台能力
 
 | 能力 | `conversation` 对象方法 | 模型工具（`conversation.tools` 上） |
@@ -228,7 +208,7 @@ interface Conversation {
 | 记忆 | `conversation.memory` | 无，开发者可以根据具体场景，自己组装成适合的模型工具 |
 | 用户授权数据 | `conversation.dataAccess.query` / `conversation.dataAccess.request` / `conversation.dataAccess.readResult` | `data_access_query` / `data_access_request` / `data_access_read_result` |
 | 小挂件 | `conversation.widget.list` / `conversation.widget.create` / `conversation.widget.read` / `conversation.widget.readModule` / `conversation.widget.rename` / `conversation.widget.writeRecord` / `conversation.widget.deleteRecord` / `conversation.widget.delete` / `conversation.widget.setPresentation` / `conversation.widget.send` | `widget_create` / `widget_read` / `widget_read_module` / `widget_rename` / `widget_write_record` / `widget_delete_record` / `widget_delete` / `widget_send` |
-| 主动服务 | `conversation.proactive.propose` / `conversation.proactive.isRunning` | `proactive_propose` |
+| 主动服务 | `conversation.proactive.subscribe` / `list` / `unsubscribe` / `unsubscribeAll` / `isRunning` | `proactive_subscribe` / `proactive_list` / `proactive_unsubscribe` / `proactive_unsubscribe_all` |
 
 ```ts
 buddy: (conversation) => ({
@@ -242,11 +222,11 @@ buddy: (conversation) => ({
 
 ### 3.1 资料
 
-把 `.md` 资料放进工程目录（`package.json` 所在目录）下的 `resources/`，把 `conversation.tools.resource_list` 和 `conversation.tools.resource_read` 放进 `initialState.tools`，模型先列出有哪些资料，再按需读。
+搭子随身带的只读资料：把 `.md` 放进工程目录下的 `resources/`，模型先列出有哪些资料，再按需读一篇。资料在进程启动时一次读好，整场会话、每个回合读到的都是同一份。
+
+**准备工作**
 
-- 工程目录从入口脚本往上找，与启动时的工作目录无关。
-- 启动时递归读取 `.md`，跳过 `node_modules`、`venv`、`.venv`、`__pycache__` 与点开头的文件和目录；资料改了要重启进程。
-- `resource_list` 列出全部资料的相对路径，`resource_read` 按路径读一篇。没有资料时 `resource_list` 回「没有资料」。
+资料放在工程目录（`package.json` 所在目录）下的 `resources/`：
 
 ```
 my-buddy/                  工程目录
@@ -257,41 +237,63 @@ my-buddy/                  工程目录
 └─ src/index.ts            入口脚本
 ```
 
-**在自己的代码里用**
+- 资料更改要重启进程，建议 watch `resources/` 实时重启。
 
-调用 `conversation.resource`，不需要把这两个工具放进 `initialState.tools`：
+**`conversation` 对象方法**
 
 | 方法 | 做什么 |
 |---|---|
 | `list()` | 全部资料的路径，相对 `resources/`，按路径排序 |
-| `read(file)` | 读一篇的正文，`file` 照 `list()` 给的路径原样填；没有这篇时抛异常 |
+| `read(file)` | 读一篇的正文，`file` 照 `list()` 给的路径原样填 |
 
 ```ts
 const notes = conversation.resource.read("research/01-writings.md");
 ```
 
+**模型工具**
+
+把 `conversation.tools.resource_list` 和 `conversation.tools.resource_read` 放进 `initialState.tools`，模型就能先列出有哪些资料，再按路径读一篇。`systemPrompt` 里交代清楚这只搭子带了哪类资料、什么时候该去翻。
+
+**限制与异常**
+
 - 两个方法都是同步的，读的是进程启动时读好的那份。
+- 没有资料时 `resource_list` 回「没有资料」。
+- `read(file)` 读不存在的那篇时抛异常。
 - 主动服务的回合内也能调。
 
 ### 3.2 提问
 
-让模型发一张题卡请用户选：一个问题加 2 到 4 个可以直接点的选项。私聊、群聊都能用。
+让模型发一张题卡请用户选：一个问题加 2 到 4 个可以直接点的选项。私聊、群聊都能用。题卡发出，这一轮就到此结束，等用户操作。
+
+**`conversation` 对象方法**
+
+没有。`conversation` 不提供发题卡的方法，题卡只由模型发。
+
+**模型工具**
 
 把 `conversation.tools.ask_question` 放进 `initialState.tools`，模型就能发题卡。
 
-- 参数是 `question`（题目，不超过 500 字）和 `options`（2 到 4 个，每个不超过 30 字，不能重复）；不合规时模型会看到错误，改了再调。
-- 用户点选项，就是用选项原文发一条消息，跟自己打字一样；也可以不点，直接打字。
-- `conversation` 对象不提供发题卡的方法，题卡只由模型发。
+- 参数是 `question`（题目，不超过 500 字）和 `options`（2 到 4 个，每个不超过 30 字，不能重复）。
+- 题目和选项只写在参数里，回复正文里不再说一遍。
+- 用户点选项，就是用选项原文发一条消息，跟自己打字一样；也可以不点，直接打字回答，或者说别的。
+
+**限制与异常**
+
+- 参数不合规时模型会看到错误，改了再调。
+- 这一轮读过用户授权数据之后不能再发题卡，调用抛异常，异常信息模型能看到；原因见 3.4 的「数据只在当轮可见」。
+- 主动服务的回合里照常能发，运行时不拦。
 
 ### 3.3 记忆
 
-这场会话的长期记忆，存在平台上，只在本会话内可见，会话删除时一并清除。
+这场会话的长期记忆，搭子写给自己的印象，存在平台上，平台只存不读。只在本会话内可见，会话删除时一并清除。
 
-- `list()`：列出全部，按 `key` 字典序。
-- `write(key, text)`：覆盖写一条。
-- `delete(key)`：删一条，不存在也算成功。
+**`conversation` 对象方法**
 
-`key` 非空、不含空白与 `/`、最长 64 字；`text` 单条不超过 16 KB；每场会话最多 64 条、合计不超过 256 KB。超限、`key` 不合法或网络出错时抛异常，异常信息是平台给出的原因，在工具里调用时模型能看到。
+| 方法 | 做什么 |
+|---|---|
+| `list()` | 列出全部，按 `key` 字典序 |
+| `write(key, text)` | 覆盖写一条 |
+| `delete(key)` | 删一条，不存在也算成功 |
 
 ```ts
 interface MemoryEntry {
@@ -301,46 +303,50 @@ interface MemoryEntry {
 }
 ```
 
-运行时不提供记忆工具，要让模型记东西，自己包一个：
+**模型工具**
+
+运行时不提供记忆工具。要让模型自己记东西，按这只搭子要记什么，自己包一个：
 
 ```ts
 const REMEMBER_PARAMS = Type.Object({ topic: Type.String(), text: Type.String() });
 
-await BuddyServer.start({
-	dataRequirements: [],
-	buddy: (conversation) => {
-		const remember: AgentTool<typeof REMEMBER_PARAMS, undefined> = {
-			name: "remember",
-			label: "正在记下",
-			description: "把一条关于对方的印象记下来，同一主题覆盖旧的。",
-			parameters: REMEMBER_PARAMS,
-			execute: async (_id, { topic, text }) => {
-				await conversation.memory.write(topic, text);
-				return { content: [{ type: "text", text: "记下了。" }], details: undefined };
-			},
-		};
-		return { initialState: { model: "kimi-k3", systemPrompt: PERSONA, tools: [remember] } };
-	},
+await BuddyServer.start((conversation) => {
+	const remember: AgentTool<typeof REMEMBER_PARAMS, undefined> = {
+		name: "remember",
+		label: "正在记下",
+		description: "把一条关于对方的印象记下来，同一主题覆盖旧的。",
+		parameters: REMEMBER_PARAMS,
+		execute: async (_id, { topic, text }) => {
+			await conversation.memory.write(topic, text);
+			return { content: [{ type: "text", text: "记下了。" }], details: undefined };
+		},
+	};
+	return { initialState: { model: "kimi-k3", systemPrompt: PERSONA, tools: [remember] } };
 });
 ```
 
+**限制与异常**
+
+- `key` 非空、不含空白与 `/`、最长 64 字；`text` 单条不超过 16 KB；每场会话最多 64 条、合计不超过 256 KB。
+- 超限、`key` 不合法或网络出错时抛异常，异常信息是平台给出的原因，在工具里调用时模型能看到。
+- 这一轮读过用户授权数据之后，运行时拒绝本回合的记忆写入，见 3.4 的「数据只在当轮可见」。
+- 主动服务的回合里跟普通回合一样能读能写，运行时不拦。
+
 ### 3.4 用户授权数据
 
-用户同意后，搭子可以读用户的睡眠、运动等数据。数据按 Dataset 分项，用户逐项同意。搭子拿不到用户的真实 id。
+用户同意后，搭子可以读用户的睡眠、运动等数据。数据按 Dataset 分项，用户逐项同意。搭子拿不到用户的真实 id。查到的数据只在当轮可见，见本节末尾。
 
 这里有三层不同概念：
 
 1. **Runtime 能力目录**：当前 SDK 支持哪些 Dataset，由包导出的 `DATA_ACCESS_CAPABILITIES` 提供。
-2. **搭子数据声明**：这只搭子实际需要其中哪些 Dataset，以及各自用途，写在 `BuddyServer.start.dataRequirements`。
+2. **搭子数据声明**：这只搭子实际需要其中哪些 Dataset，以及各自用途，写在工程根目录的 `data-access.json`。
 3. **用户 Grant**：用户是否同意这只搭子读取某个已声明 Dataset，由客户端授权流程管理，搭子不能代替用户授予。
 
-把 `data_access_query`、`data_access_request` 等平台工具放进 `initialState.tools`，只决定模型能不能调用它们，不等于声明 Dataset，也不等于获得用户授权。
-
-位置和日历是当前会话的一次性授权结果，通过 `data_access_request` 请求，不属于 Dataset，也不写进 `dataRequirements`。HealthKit 数据会形成可重复查询的 Dataset，因此必须先在 `dataRequirements` 中声明。
+位置和日历是当前会话的一次性授权结果，通过 `data_access_request` 请求，不属于 Dataset，也不写进 `data-access.json`。HealthKit 数据会形成可重复查询的 Dataset，因此必须先在配置中声明。
 
-**读取 Runtime 能力目录**
+**准备工作**
 
-开发者工具和项目代码直接从 Runtime 包导入，不需要网络请求：
+Runtime 能力目录直接从 Runtime 包导入，开发者工具和项目代码都不需要网络请求：
 
 ```ts
 import {
@@ -358,24 +364,25 @@ const sleep = dataAccessCapability("health.sleep");
 
 这份导出是开发者可选 `id` 的权威来源。新增 Dataset 随 Runtime 版本发布；developer-platform、脚手架和预检都应读取该导出，不再维护一份手写枚举。
 
-**声明需要哪些数据**
-
-声明写在 `BuddyServer.start` 的初始化参数里，Runtime 在本地展开成带标题、来源和 Schema 版本的完整声明：
+声明写在工程根目录（与 `package.json` 同级）的 `data-access.json`：
 
-```ts
-await BuddyServer.start({
-	dataRequirements: [
-		{ id: "health.sleep", purpose: "根据你最近的睡眠调整作息建议" },
-	],
-	buddy: () => ({ /* ... */ }),
-});
+```json
+{
+	"requirements": [
+		{ "id": "health.sleep", "purpose": "根据你最近的睡眠调整作息建议" }
+	]
+}
 ```
 
-- `id`：从 `DATA_ACCESS_CAPABILITIES` 中选，TypeScript 会收窄为 `DataAccessDatasetId`。
+- `id`：从 `DATA_ACCESS_CAPABILITIES` 中选。
 - `purpose`：用途，1～200 字。用户看到这句话再决定是否同意。
-- Runtime 不在启动时注册声明；查询、HealthKit 权限卡和主动服务请求会携带当前完整声明。
-- Server 在实际请求时按声明用途和 Schema 计算版本；`id`、`purpose` 与 Schema 都没变化时保留已有 Grant，变化后要求重新授权。
-- 本地进程连接线上网关时使用 `<buddyId>-dev` 身份，实际使用形成的授权上下文与正式搭子隔离。
+- `requirements` 最多 32 项，不允许重复；配置对象和每一项都不接受额外字段。
+- 文件缺失等价于 `{ "requirements": [] }`。Runtime 启动时先严格校验，再把整份声明上传平台；即使为空也会上传，以清除旧声明。上传失败则启动失败。
+- Server 在注册时按声明用途和 Schema 计算版本；`id`、`purpose` 与 Schema 都没变化时保留已有 Grant，变化后要求重新授权。
+- 后续查询、HealthKit 权限卡和主动服务请求只发送 Dataset ID，不再重复携带用途声明。
+- 本地 `.env` 里放的是 CLI 发的开发令牌，进程连上平台后身份是 `<buddyId>-dev`，实际使用形成的授权上下文与正式搭子隔离。
+
+可以声明的 Dataset：
 
 | Dataset | 内容 | `data.items` 每条的字段 |
 |---|---|---|
@@ -390,34 +397,45 @@ await BuddyServer.start({
 
 部分字段可能缺失，取值前先判断。
 
-**模型工具与代码接口**
+**`conversation` 对象方法**
 
-- `data_access_query` / `conversation.dataAccess.query`：查询已授权 Dataset。
-- `data_access_request` / `conversation.dataAccess.request`：在私聊中发数据授权卡；发卡后当前回合结束，等待用户操作。
-- `data_access_read_result` / `conversation.dataAccess.readResult`：按授权卡的 `requestId` 读取一次性位置或日历结果；HealthKit 不走这个接口。
+开发者自己的工具直接调用 `conversation.dataAccess`，不用把 `data_access_*` 放进 `initialState.tools`：
 
-模型工具要从 `conversation.tools` 取来放进 `initialState.tools` 才能调用；没声明 Dataset 时照常注册，查询的每一项都回 `notDeclared`。开发者自己的工具直接调用 `conversation.dataAccess`，不用把这几个工具放进去。
+| 方法 | 做什么 |
+|---|---|
+| `query({ datasets, memberId? })` | 查询已授权 Dataset，每个 Dataset 各自一个状态 |
+| `request({ kind, reason, datasets?, calendarDays?, idempotencyKey })` | 在私聊里发数据授权卡，`kind` 取 `healthkit`、`location` 或 `calendar` |
+| `readResult(requestId)` | 按授权卡的 `requestId` 读一次性的位置或日历结果；HealthKit 不走这个接口 |
 
-**HealthKit：先查询，缺授权再发卡**
+```ts
+const [sleep] = await conversation.dataAccess.query({ datasets: ["health.sleep"] });
+if (sleep.status === "available") {
+	// sleep.data.items 是每天一条的睡眠记录
+}
+```
+
+- `datasets`：一次最多 8 个。
+- `memberId`：私聊不传；群聊必传，取群消息开头 `[名字 #m_…]` 里的 `m_…`，查这位成员的数据，传错时抛异常。
+
+**模型工具**
+
+把 `conversation.tools.data_access_query`、`data_access_request`、`data_access_read_result` 放进 `initialState.tools`，模型就能自己查数据、发授权卡。放进去只决定模型能不能调用它们，不等于声明 Dataset，也不等于获得用户授权；没声明 Dataset 时照常注册，查询的每一项都回 `notDeclared`。
+
+HealthKit 先查询，缺授权再发卡：
 
 ```ts
-await BuddyServer.start({
-	dataRequirements: [
-		{ id: "health.sleep", purpose: "根据你最近的睡眠调整作息建议" },
-	],
-	buddy: (conversation) => ({
-		initialState: {
-			model: "kimi-k3",
-			systemPrompt: [
-				"聊到作息时，先用 data_access_query 查询 health.sleep。",
-				"返回 notGranted 时，说明当前问题为什么需要数据，再用 data_access_request 发 HealthKit 授权卡。",
-				"用户处理授权卡后会开启新回合；再次调用 data_access_query，不要调用 data_access_read_result。",
-				"用户拒绝后不要在同一任务里反复申请。",
-			].join("\n"),
-			tools: [conversation.tools.data_access_query, conversation.tools.data_access_request],
-		},
-	}),
-});
+await BuddyServer.start((conversation) => ({
+	initialState: {
+		model: "kimi-k3",
+		systemPrompt: [
+			"聊到作息时，先用 data_access_query 查询 health.sleep。",
+			"返回 notGranted 时，说明当前问题为什么需要数据，再用 data_access_request 发 HealthKit 授权卡。",
+			"用户处理授权卡后会开启新回合；再次调用 data_access_query，不要调用 data_access_read_result。",
+			"用户拒绝后不要在同一任务里反复申请。",
+		].join("\n"),
+		tools: [conversation.tools.data_access_query, conversation.tools.data_access_request],
+	},
+}));
 ```
 
 完整链路：
@@ -432,11 +450,7 @@ data_access_query
 → available + data
 ```
 
-查询接口不会把“从未授权”和“用途变化后需重新确认”分成两种模型状态，都会返回 `notGranted`；重新确认原因由用户侧授权页面展示。
-
-**位置和日历：读取一次性结果**
-
-位置和日历不属于 Dataset，不写进 `dataRequirements`。模型先用 `data_access_request` 发卡，用户处理后，隐藏结果会带回这张卡的 `requestId`；再用 `data_access_read_result` 读取。结果只在平台短期保存，读不到时返回 `unavailable`。
+位置和日历不属于 Dataset，不写进 `data-access.json`。模型先用 `data_access_request` 发卡，用户处理后，隐藏结果会带回这张卡的 `requestId`；再用 `data_access_read_result` 读取。结果只在平台短期保存，读不到时返回 `unavailable`。
 
 ```text
 data_access_request { kind: "location", reason: "查找你附近的地点" }
@@ -446,19 +460,9 @@ data_access_request { kind: "location", reason: "查找你附近的地点" }
 → available + data，或 unavailable
 ```
 
-`calendar` 还可传 `calendarDays`，范围为 1～31，默认 7。授权请求第一期只支持私聊；群聊需要引导目标成员去私聊操作。
+`calendar` 还可传 `calendarDays`，范围为 1～31，默认 7。
 
-**开发者代码查询 Dataset**
-
-```ts
-const [sleep] = await conversation.dataAccess.query({ datasets: ["health.sleep"] });
-if (sleep.status === "available") {
-	// sleep.data.items 是每天一条的睡眠记录
-}
-```
-
-- `datasets`：一次最多 8 个；响应超过 512 KiB 时抛异常，减少 Dataset 再查。
-- `memberId`：私聊不传；群聊必传，取群消息开头 `[名字 #m_…]` 里的 `m_…`，查这位成员的数据，传错时抛异常。
+**限制与异常**
 
 每个 Dataset 各自一个状态，只有 `available` 带 `data`：
 
@@ -470,22 +474,27 @@ if (sleep.status === "available") {
 | `disabledInGroup` | 这位成员在这个群里关掉了这项数据 |
 | `unavailable` | 平台上还没有这位用户的这项数据，或数据已过期 |
 
+- 查询接口不会把「从未授权」和「用途变化后需重新确认」分成两种模型状态，都会返回 `notGranted`；重新确认原因由用户侧授权页面展示。
+- 一次查询的响应超过 512 KiB 时抛异常，减少 Dataset 再查。
+- 发出授权卡后当前回合结束，等待用户操作。
+- 授权请求第一期只支持私聊；群聊需要引导目标成员去私聊操作。
+
 **数据只在当轮可见**
 
-查到的数据只用于这一轮回复：平台不存原文，搭子进程里的那份也在这一轮结束时被抹掉，下一轮读不到。凡是可能把它带出去的地方——工具结果、工具参数、那一步的正文和心声——这一轮统统不写进平台。
+查到的数据只用于这一轮回复：平台不存原文，搭子进程里的那份也在这一轮结束时被抹掉，下一轮读不到。Runtime 按步骤追踪数据流：读取数据之前已经生成的工具步骤正常保留；DataAccess 结果只保留 Dataset 状态；模型看到数据后生成的工具参数、工具结果、工具步骤正文和心声不写进平台，最终给用户看的普通回复只保留正文、不保留心声。
 
-这么设计是为了**用户撤销授权时能真的收回**：数据没有留在任何地方，不需要事后去清。代价是这一轮的记录不完整，搭子重启后读不到自己当时的推理和工具参数。
+这么设计是为了**用户撤销授权时能真的收回**：确保模型不会记住授权的具体数据。
 
 由此有两条实操结论：
 
 - **想让某个结论以后还在场，就在回复里说出来**（用户也会看到）。模型对这些数据的记忆只能活在它说过的话里——下次它读到的是「查了 health.sleep，可用」，不是具体数字。
-- **别把查到的数据写进记忆、小挂件或别的工具的参数**。那些地方不脱敏，写进去就永久留下了。
+- **不要把查到的数据写进记忆、题卡、小挂件或别的工具参数**。Runtime 会直接拒绝当前回合的记忆写入和题卡发送，并脱敏后续工具调用；其他开发者自定义持久化能力仍需自行遵守这条边界。
 
 ### 3.5 小挂件
 
-小挂件是会话里一块给用户看的结构化面板，比如一份菜单。模型通过平台工具、开发者通过 `conversation.widget`，都能建小挂件、读整个或一个模块、改标题、写记录、删记录、删整个小挂件，并把它发进聊天。
+小挂件是会话里一块给用户看的结构化面板，比如一份菜单。建小挂件、读整个或一个模块、改标题、写记录、删记录、删整个小挂件，并把它发进聊天，模型和开发者代码都能做。
 
-**放进工程目录**
+**准备工作**
 
 一个小挂件是工程目录下 `widgets/` 里的一个子目录，目录名就是小挂件类型 id。
 
@@ -499,18 +508,22 @@ my-buddy/                  工程目录
 └─ src/index.ts
 ```
 
-**让模型使用**
-
-把要用的 `conversation.tools.widget_*` 放进 `initialState.tools`。
-
-- 工具说明里附上各类型的模块与字段。改了 `widgets/` 要重启进程。
-- 这场会话里已有哪些小挂件，平台会在消息里告诉模型。
-- 平台请求失败时，模型只看到「平台请求失败（HTTP 409），请查询最新状态后再操作」这类提示，不带具体原因。
-- `widget_send` 把小挂件放进发送队列就返回，不等平台确认送达。
+资料小挂件要重启进程，建议 watch `widgets/` 实时重启。
 
-**在自己的代码里用**
+**`conversation` 对象方法**
 
-调用 `conversation.widget`，不需要把 `widget_*` 放进工具：
+| 方法 | 做什么 |
+|---|---|
+| `list()` | 列出这场会话里的小挂件，不带记录 |
+| `create({ type, title, idempotencyKey? })` | 新建一个，回 `{ id }`；同一个 `idempotencyKey` 重复建回同一个 id |
+| `read(id)` | 读整个小挂件，含各模块的记录 |
+| `readModule(id, module)` | 读一个模块，回 `{ records }` |
+| `rename(id, title)` | 改标题，id 不变，聊天里发过的卡片跟着显示新标题 |
+| `writeRecord(id, { module, recordId, data, expectedRevision? })` | 写一条记录，已存在就整条覆盖，回 `{ revision }`；带 `expectedRevision` 时版本号对不上，平台回 409 |
+| `deleteRecord(id, module, recordId)` | 删一条记录 |
+| `delete(id)` | 删整个小挂件连记录；聊天里发过的卡片留着，点开显示已删除 |
+| `setPresentation(id, { summary, imageMediaId })` | 设聊天里卡片的摘要（不超过 500 字）和封面图，`imageMediaId` 传空串去掉封面 |
+| `send(id, { idempotencyKey })` | 发进聊天：放进发送队列就返回，不等平台确认送达；同一个 `idempotencyKey` 重复发只落一条 |
 
 ```ts
 execute: async (toolCallId, params) => {
@@ -521,18 +534,16 @@ execute: async (toolCallId, params) => {
 },
 ```
 
-| 方法 | 做什么 | 平台接口 |
-|---|---|---|
-| `list()` | 列出这场会话里的小挂件，不带记录 | `GET /internal/v1/widgets` |
-| `create({ type, title, idempotencyKey? })` | 新建一个，回 `{ id }`；同一个 `idempotencyKey` 重复建回同一个 id | `POST /internal/v1/widgets` |
-| `read(id)` | 读整个小挂件，含各模块的记录 | `GET /internal/v1/widgets/:widgetId` |
-| `readModule(id, module)` | 读一个模块，回 `{ records }` | `GET /internal/v1/widgets/:widgetId/:module` |
-| `rename(id, title)` | 改标题，id 不变，聊天里发过的卡片跟着显示新标题 | `PUT /internal/v1/widgets/:widgetId` |
-| `writeRecord(id, { module, recordId, data, expectedRevision? })` | 写一条记录，已存在就整条覆盖，回 `{ revision }`；带 `expectedRevision` 时版本号对不上，平台回 409 | `PUT /internal/v1/widgets/:widgetId/:module/:recordId` |
-| `deleteRecord(id, module, recordId)` | 删一条记录 | `DELETE /internal/v1/widgets/:widgetId/:module/:recordId` |
-| `delete(id)` | 删整个小挂件连记录；聊天里发过的卡片留着，点开显示已删除 | `DELETE /internal/v1/widgets/:widgetId` |
-| `setPresentation(id, { summary, imageMediaId })` | 设聊天里卡片的摘要（不超过 500 字）和封面图，`imageMediaId` 传空串去掉封面 | `PUT /internal/v1/widgets/:widgetId/presentation` |
-| `send(id, { idempotencyKey })` | 发进聊天：放进发送队列就返回，不等平台确认送达；同一个 `idempotencyKey` 重复发只落一条 | `POST /internal/v1/messages` |
+**模型工具**
+
+把要用的 `conversation.tools.widget_*` 放进 `initialState.tools`，模型就能自己建、读、改、发小挂件。
+
+- 工具说明里附上各类型的模块与字段，模型不用另外交代形状。
+- 这场会话里已有哪些小挂件，平台会在消息里告诉模型。
+- 平台请求失败时，模型只看到「平台请求失败（HTTP 409），请查询最新状态后再操作」这类提示，不带具体原因。
+- `widget_send` 把小挂件放进发送队列就返回，不等平台确认送达。
+
+**限制与异常**
 
 - `list` 和 `read` 回的 `canEdit` 为 `false` 的，是别的会话转发来的引用，只能读；改名、写记录、删除、设卡片时平台回 403。
 - `data` 要符合 `schema.json` 里这个模块的 `record`，不符合时平台回 400。
@@ -543,53 +554,64 @@ execute: async (toolCallId, params) => {
 
 让搭子在约定的时机主动找用户说话，比如每周一次复盘。目前主动服务仅支持私聊。
 
-1. 搭子向平台提一条主动服务的订阅记录，其中包含触发主动服务的条件。
+1. 搭子按稳定 `key` 向平台创建或更新一条主动服务订阅，其中包含触发条件；相同 `key` 不会重复创建。
 2. 触发条件满足，且没被免打扰时段、冷却时间、每日上限拦下时，平台向搭子发起一次主动服务的回合。
 3. 模型判断要不要开口：要就直接写出发给用户的消息，平台在落库那一刻再过一遍闸门，过了才发给用户，拦下就不发；不要就输出跳过标记，这一轮到此结束，用户什么也看不到。
 
-提订阅有两种方式，二选一或并用。字段一样（见下表），产物都是一条订阅，只是谁决定何时提不同：
+**`conversation` 对象方法**
 
-- 你的代码显式调 `conversation.proactive.propose`。它挂在这场会话的 `conversation` 上，凡是拿得到 `conversation` 的地方都能调：自己工具的 `execute` 里、`beforeToolCall` / `afterToolCall` 里、配置工厂函数体里：
+| 方法 | 做什么 |
+|---|---|
+| `subscribe(key, request)` | 按稳定 `key` 创建或更新一条订阅，相同 `key` 更新原订阅并重新启用 |
+| `list()` | 当前会话的全部订阅，包括已关闭项 |
+| `unsubscribe(key)` | 关闭指定订阅，回是否找到 |
+| `unsubscribeAll()` | 关闭全部 active 订阅，回关掉几条 |
+| `isRunning()` | 现在是不是主动服务的回合 |
+
+它挂在这场会话的 `conversation` 上，凡是拿得到 `conversation` 的地方都能调：自己工具的 `execute` 里、`beforeToolCall` / `afterToolCall` 里、配置工厂函数体里。
 
 ```ts
-await conversation.proactive.propose({
+await conversation.proactive.subscribe("weekly-review", {
 	title: "每周复盘",
 	reason: "在约定时间结合最近聊天做一次简短复盘",
-	sources: ["schedule"],
-	eventTypes: ["schedule.due"],
-	schedule: { at: firstReviewAt, intervalMinutes: 7 * 24 * 60 },
+	trigger: { type: "schedule", at: firstReviewAt, intervalMinutes: 7 * 24 * 60 },
 });
 ```
 
-- 模型决定要不要提，把 `conversation.tools.proactive_propose` 放进 `initialState.tools`。什么场景该提，在 `systemPrompt` 里说清楚，注册进模型工具意味着用户也可以开口要求搭子主动服务：
-
-```ts
-await BuddyServer.start({
-	dataRequirements: [{ id: "health.workouts", purpose: "跑完后帮你复盘这次训练" }],
-	buddy: (conversation) => ({
-		initialState: {
-			model: "kimi-k3",
-			systemPrompt: "你是跑步搭子。用户表达想坚持训练时，可以用 proactive_propose 提议跑完步帮他复盘。",
-			tools: [conversation.tools.proactive_propose, conversation.tools.data_access_query],
-		},
-	}),
-});
-```
+`subscribe` 的字段：
 
 | 字段 | 说明 |
 |---|---|
+| `key` | 必填，订阅的稳定标识：1～64 位小写字母、数字、点、下划线或横线，首位为字母或数字；相同 `key` 更新原订阅并重新启用 |
 | `title` | 必填，订阅名称，最长 100 字 |
 | `reason` | 必填，为什么要主动找用户，最长 500 字 |
-| `sources` | 必填，触发来源，`[]` 表示不限 |
-| `eventTypes` | 必填，至少一个，触发事件类型 |
-| `schedule` | 可选，定时触发：`at` 为首次时刻（UTC 毫秒），`intervalMinutes` 为重复间隔（60～525600），按固定间隔算，不随夏令时调整。用它时 `eventTypes` 要含 `schedule.due`，`sources` 为 `[]` 或含 `schedule` |
+| `trigger` | 必填，什么时候触发：`workout.completed`、`sleep.ready`、`{ type: "data.updated", dataset? }`，或 `{ type: "schedule", at, intervalMinutes? }`。一条订阅只对应一种触发 |
 | `quietHours` | 可选，免打扰时段，缺省 `{ start: "22:30", end: "08:00", timezone: "Asia/Shanghai" }` |
 | `cooldownMinutes` | 可选，冷却时间，缺省 120，取 0～10080 |
 | `dailyLimit` | 可选，每天最多几次，缺省 3，取 1～20 |
 
-字段不合法、在群聊里调用，或同一用户对这只搭子已有 20 个未撤销的订阅时抛异常。
+**模型工具**
+
+让模型自己决定是否订阅或关闭时，把需要的 `conversation.tools.proactive_*` 放进 `initialState.tools`，字段与上面那张表一样。什么场景可以订阅、何时只能查询或关闭，要在 `systemPrompt` 里说清楚：
+
+```ts
+await BuddyServer.start((conversation) => ({
+	initialState: {
+		model: "kimi-k3",
+		systemPrompt: "你是跑步搭子。用户表达想坚持训练时，可以用 proactive_subscribe 订阅跑后复盘；用户要求关闭时先查询再关闭。",
+		tools: [conversation.tools.proactive_subscribe, conversation.tools.proactive_list, conversation.tools.proactive_unsubscribe, conversation.tools.data_access_query],
+	},
+}));
+```
+
+代码订阅和模型订阅二选一或并用，产物都是一条订阅，只是谁决定何时订阅不同。
+
+**限制与异常**
+
+- 字段不合法、在群聊里调用，或同一用户对这只搭子已有 20 个 active 订阅时抛异常。
+- 关闭订阅时，尚未完成的主动服务会同步取消。
 
-#### 主动服务的回合，不允许使用部分模型工具
+**主动服务的回合，不允许使用部分模型工具**
 
 主动服务的回合里工具清单一个字都不动，平台工具和你自己的工具都照常执行，运行时不按回合性质拦任何一个。有时我们想禁用部分模型工具，比如一些写操作，可以使用 `beforeToolCall` 的钩子函数，用 `conversation.proactive.isRunning()` 能判断当前是不是主动服务的回合：
 

package/dist/conversation/agent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../../src/conversation/agent.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAExF,OAAO,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAGxD,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7D,OAAO,EAAkB,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAEhF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAKrD,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAA8B,eAAe,EAAE,iBAAiB,EAAiB,MAAM,aAAa,CAAC;AAE5I,MAAM,WAAW,SAAS;IACzB,mCAAmC;IACnC,cAAc,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,CAAC;IACrD,wCAAwC;IACxC,gBAAgB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,SAAS,CAAC;IAClB,uEAAuE;IACvE,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;IACnB,iEAAiE;IACjE,KAAK,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,uDAAuD;IACvD,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,gBAAgB,EAAE,SAAS,eAAe,EAAE,CAAC;IAC7C,OAAO,EAAE,YAAY,CAAC;IACtB,GAAG,EAAE,WAAW,CAAC;IACjB,oCAAoC;IACpC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;CACnD;AAED,wDAAwD;AACxD,MAAM,WAAW,YAAY;IAC5B,KAAK,EAAE,KAAK,CAAC;IACb,yDAAyD;IACzD,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAClB,eAAe,EAAE,sBAAsB,CAAC;IACxC,iFAAiF;IACjF,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,kFAAkF;AAClF,wBAAsB,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,CAyLxE;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,iHAAuB,CAAC;AAEtD,iEAAiE;AACjE,wBAAgB,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,MAAM,GAAG,YAAY,EAAE,CAErF;AAED,iDAAiD;AACjD,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAQxD"}
+{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../../src/conversation/agent.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAExF,OAAO,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAGxD,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7D,OAAO,EAAkB,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAEhF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAKrD,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAA8B,eAAe,EAAE,iBAAiB,EAAiB,MAAM,aAAa,CAAC;AAE5I,MAAM,WAAW,SAAS;IACzB,mCAAmC;IACnC,cAAc,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,CAAC;IACrD,wCAAwC;IACxC,gBAAgB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,SAAS,CAAC;IAClB,uEAAuE;IACvE,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;IACnB,iEAAiE;IACjE,KAAK,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,uDAAuD;IACvD,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,gBAAgB,EAAE,SAAS,eAAe,EAAE,CAAC;IAC7C,OAAO,EAAE,YAAY,CAAC;IACtB,GAAG,EAAE,WAAW,CAAC;IACjB,oCAAoC;IACpC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;CACnD;AAED,wDAAwD;AACxD,MAAM,WAAW,YAAY;IAC5B,KAAK,EAAE,KAAK,CAAC;IACb,yDAAyD;IACzD,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAClB,eAAe,EAAE,sBAAsB,CAAC;IACxC,iFAAiF;IACjF,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,kFAAkF;AAClF,wBAAsB,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,CAwMxE;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,iHAAuB,CAAC;AAEtD,iEAAiE;AACjE,wBAAgB,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,MAAM,GAAG,YAAY,EAAE,CAErF;AAED,iDAAiD;AACjD,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAQxD"}