page-agent-sdk 2.6.0 → 2.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "page-agent-sdk",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "type": "module",
   "description": "框架无关的页面内 Agent JS SDK —— 以对话框形态挂载到任意网页,通过自定义 tool 读写宿主预注册的数据槽(经 schema 校验 + jsonPath 增量 patch + 快照回退;GET 抓文档),具备 planning/skills/虚拟工作区/context 管理能力。Vue 打包进库,使用者无需安装 Vue。",
   "main": "./dist/page-agent-sdk.umd.cjs",

package/skills/page-agent-sdk-integrate/SKILL.md

@@ -27,7 +27,7 @@ See `demo/plain.html` for a framework-agnostic importmap + esm.sh example.
 
 Create a plain/reactive object as the main data, then declare it with a zod schema. The agent can ONLY touch schema-declared top-level fields (ZodObject auto-whitelist); `set`/`edit` are schema-validated (invalid → structured error, no write). Field `.describe()` text is auto-injected into the system prompt so the LLM knows each field's purpose.
 
-> `systemPrompt` is optional — a built-in default is used if omitted (generic JSON-operation assistant + `systemPromptHelpers.reliableWriteRules`: read-before-write, fields per `describe`, retry on validation error, prefer incremental `edit`). Passing your own fully overrides it. Two ways to keep the write rules with a custom prompt: (a) append `systemPromptHelpers.reliableWriteRules` yourself, or (b) set `appendReliableWriteRules: true` to auto-append them (default `false` to avoid duplication).
+> `systemPrompt` is optional — a built-in default is used if omitted (generic JSON-operation assistant + `systemPromptHelpers.reliableWriteRules`: read-before-write, fields per `describe`, retry on validation error, prefer incremental `edit`). Passing your own fully overrides it. By default (`appendReliableWriteRules: true`, the default), the SDK auto-appends `reliableWriteRules` to your custom `systemPrompt` with a `---` separator (clearly distinguishing your content from the SDK-appended write rules); set `appendReliableWriteRules: false` to disable.
 
 ```ts
 import { createChatSdk, z } from 'page-agent-sdk'

package/skills/page-agent-sdk-integrate/references/api.md

@@ -74,7 +74,7 @@ createChatSdk({
 
 `reliableWriteRules` — standardized "reliable write rules": read before write (`read`), fields per `read({jsonPath})` (returns format hint), retry on schema-validation errors, prefer `write` with `patch` incremental edits. Recommended for any scenario involving data writes.
 
-Two ways to keep the rules with a custom `systemPrompt`: (a) append manually as above, or (b) set `appendReliableWriteRules: true` to auto-append (default `false`). The default prompt (when `systemPrompt` omitted) already includes them.
+By default (`appendReliableWriteRules: true`), the SDK auto-appends `reliableWriteRules` to your custom `systemPrompt` with a `---` separator (clearly distinguishing your content from the SDK-appended write rules); set `appendReliableWriteRules: false` to disable. The default prompt (when `systemPrompt` omitted) already includes them.
 
 ## Built-in data tools (auto-injected when `capabilities.dataOps`)
 

package/skills/page-agent-sdk-integrate/references/options.md

@@ -8,7 +8,7 @@ Full reference for `createChatSdk(options)`. Grouped by purpose. Required: `llm`
 |---|---|---|---|
 | `llm` | `LLMConfig \| BaseChatModel` | — (required) | The model. `LLMConfig = { apiKey, baseUrl, model, temperature?, maxTokens? }` (OpenAI-compatible; DeepSeek default). Or pass any LangChain `BaseChatModel` (e.g. `ChatAnthropic`, install its peerDep). |
 | `systemPrompt` | `string` | built-in default (JSON-operation assistant + reliable write rules) | Agent identity/instructions. Inject here, not hardcoded. Keep single-line in `.env` (`VITE_AI_SYSTEM_PROMPT`). If omitted, a built-in default is used (JSON-operation assistant + `systemPromptHelpers.reliableWriteRules`); passing your own fully overrides it. |
-| `appendReliableWriteRules` | `boolean` | `false` | When `true` and a custom `systemPrompt` is set, auto-append `systemPromptHelpers.reliableWriteRules` to it (avoids forgetting the write rules). No effect when `systemPrompt` is omitted (default prompt already includes them). |
+| `appendReliableWriteRules` | `boolean` | `true` | When `true` (default) and a custom `systemPrompt` is set, auto-append `systemPromptHelpers.reliableWriteRules` to it with a `---` separator (clearly distinguishes user content from SDK-appended write rules; avoids forgetting the write rules). Set `false` to disable. No effect when `systemPrompt` is omitted (default prompt already includes them). |
 | `id` | `string` | random + warn | Stable agent id for multi-agent isolation & persistence. **Must pass a stable value** if you use `storage` or run multiple agents on one page. |
 | `title` / `placeholder` | `string` | — | Dialog title / input placeholder (cosmetic). |
 

package/types/index.d.ts

@@ -340,7 +340,7 @@ export interface ChatSdkOptions {
   /** 共享上下文:默认 false;true 时同 id 复用同一核心(messages/agent/工作区) */
   shareContext?: boolean;
   systemPrompt?: string;
-  /** 自定义 systemPrompt 时是否自动追加 reliableWriteRules(默认 false;不传 systemPrompt 用默认 prompt 时已内置,此项无效) */
+  /** 自定义 systemPrompt 时是否自动追加 reliableWriteRules(默认 true,用 '---' 分隔线区分;设 false 关闭;不传 systemPrompt 用默认 prompt 时已内置,此项无效) */
   appendReliableWriteRules?: boolean;
   tools?: any[];
   skills?: SkillSpec[];