remnote-bridge 0.1.11 → 0.1.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli/addon/addon-manager.js +163 -0
- package/dist/cli/addon/registry.js +24 -0
- package/dist/cli/commands/addon.js +149 -0
- package/dist/cli/commands/clean.js +121 -52
- package/dist/cli/commands/connect.js +72 -33
- package/dist/cli/commands/disconnect.js +19 -19
- package/dist/cli/commands/edit-rem.js +8 -36
- package/dist/cli/commands/edit-tree.js +3 -20
- package/dist/cli/commands/health.js +19 -18
- package/dist/cli/commands/read-context.js +3 -20
- package/dist/cli/commands/read-globe.js +3 -20
- package/dist/cli/commands/read-rem.js +6 -32
- package/dist/cli/commands/read-tree.js +3 -20
- package/dist/cli/commands/search.js +97 -21
- package/dist/cli/config.js +148 -72
- package/dist/cli/daemon/daemon.js +104 -24
- package/dist/cli/daemon/dev-server.js +9 -1
- package/dist/cli/daemon/pid.js +36 -22
- package/dist/cli/daemon/registry.js +160 -0
- package/dist/cli/daemon/send-request.js +11 -11
- package/dist/cli/daemon/static-server.js +97 -34
- package/dist/cli/handlers/edit-handler.js +49 -140
- package/dist/cli/handlers/read-handler.js +9 -9
- package/dist/cli/handlers/rem-cache.js +10 -5
- package/dist/cli/handlers/tree-parser.js +16 -9
- package/dist/cli/main.js +67 -19
- package/dist/cli/protocol.js +18 -4
- package/dist/cli/server/config-server.js +280 -14
- package/dist/cli/server/ws-server.js +93 -44
- package/dist/cli/utils/output.js +29 -0
- package/dist/mcp/format.js +43 -0
- package/dist/mcp/index.js +0 -55
- package/dist/mcp/instructions.js +424 -216
- package/dist/mcp/resources/edit-rem-guide.js +37 -158
- package/dist/mcp/resources/edit-tree-guide.js +1 -1
- package/dist/mcp/resources/error-reference.js +9 -13
- package/dist/mcp/resources/rem-object-fields.js +6 -6
- package/dist/mcp/tools/edit-tools.js +69 -8
- package/dist/mcp/tools/infra-tools.js +44 -8
- package/dist/mcp/tools/read-tools.js +136 -20
- package/package.json +2 -2
- package/remnote-plugin/dist/bridge_widget-sandbox.js +17 -17
- package/remnote-plugin/dist/bridge_widget.js +17 -17
- package/remnote-plugin/dist/index-sandbox.js +31 -31
- package/remnote-plugin/dist/index.js +31 -31
- package/remnote-plugin/dist/manifest.json +1 -1
- package/remnote-plugin/package.json +1 -1
- package/remnote-plugin/public/manifest.json +1 -1
- package/remnote-plugin/src/bridge/multi-connection-manager.ts +151 -0
- package/remnote-plugin/src/bridge/websocket-client.ts +62 -16
- package/remnote-plugin/src/services/index.ts +0 -8
- package/remnote-plugin/src/services/read-rem.ts +1 -9
- package/remnote-plugin/src/services/search.ts +13 -10
- package/remnote-plugin/src/settings.ts +9 -7
- package/remnote-plugin/src/utils/index.ts +0 -5
- package/remnote-plugin/src/widgets/bridge_widget.tsx +105 -20
- package/remnote-plugin/src/widgets/index.tsx +41 -44
- package/remnote-plugin/webpack.config.js +35 -0
- package/skills/remnote-bridge/SKILL.md +45 -40
- package/skills/remnote-bridge/instructions/addon.md +134 -0
- package/skills/remnote-bridge/instructions/clean.md +110 -0
- package/skills/remnote-bridge/instructions/connect.md +80 -37
- package/skills/remnote-bridge/instructions/disconnect.md +22 -9
- package/skills/remnote-bridge/instructions/edit-rem.md +113 -327
- package/skills/remnote-bridge/instructions/health.md +23 -13
- package/skills/remnote-bridge/instructions/install-skill.md +58 -0
- package/skills/remnote-bridge/instructions/overall.md +99 -35
- package/skills/remnote-bridge/instructions/read-rem.md +15 -15
- package/skills/remnote-bridge/instructions/search.md +77 -18
- package/skills/remnote-bridge/instructions/setup.md +5 -6
package/dist/mcp/instructions.js
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
export const SERVER_INSTRUCTIONS = `
|
|
2
2
|
# RemNote Bridge MCP Server — Agent 操作手册
|
|
3
3
|
|
|
4
|
-
RemNote
|
|
4
|
+
RemNote 知识库操作工具集。通过这些工具读取、搜索、编辑用户的 RemNote 笔记和知识结构。不能操控闪卡(Card/Flashcard)本身——闪卡由 RemNote 根据 Rem 属性自动生成。
|
|
5
5
|
|
|
6
|
-
> **架构备注**:本 MCP Server 是
|
|
6
|
+
> **架构备注**:本 MCP Server 是 \`remnote-bridge\` CLI 的包装层,每个工具调用在底层都会转化为一次 CLI 子进程调用(\`--json\` 模式)。错误消息中的"守护进程"/"daemon"指 CLI 的后台守护进程。
|
|
7
7
|
|
|
8
8
|
---
|
|
9
9
|
|
|
@@ -11,12 +11,10 @@ RemNote 知识库操作工具集。你可以通过这些工具读取、搜索、
|
|
|
11
11
|
|
|
12
12
|
### Everything is Rem
|
|
13
13
|
|
|
14
|
-
用户说的"笔记"、"文档"、"文件夹"、"闪卡",底层都是 **Rem**。不同形态通过属性区分:
|
|
15
|
-
|
|
16
14
|
| 用户说的 | 实际上是 | 区分方式 |
|
|
17
15
|
|:---------|:---------|:---------|
|
|
18
16
|
| 笔记 / 条目 | Rem | 最基本的数据单元 |
|
|
19
|
-
| 文档 / 页面 | Rem
|
|
17
|
+
| 文档 / 页面 | Rem(\`isDocument=true\`) | 可独立打开的页面 |
|
|
20
18
|
| 文件夹 | Rem(Document + 子节点全是 Document) | UI 概念,无独立标记 |
|
|
21
19
|
| 闪卡 | Card——由 Rem 属性自动生成 | **不可直接操控** |
|
|
22
20
|
|
|
@@ -26,69 +24,105 @@ Rem 有两个独立维度:**type**(闪卡语义)和 **isDocument**(页
|
|
|
26
24
|
|
|
27
25
|
| type | 含义 | UI 表现 |
|
|
28
26
|
|:-----|:-----|:--------|
|
|
29
|
-
|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
27
|
+
| \`concept\` | 概念定义 | 文字**加粗** |
|
|
28
|
+
| \`descriptor\` | 描述/属性 | 正常字重 |
|
|
29
|
+
| \`default\` | 普通 Rem | 正常字重 |
|
|
30
|
+
| \`portal\` | 嵌入引用容器 | 紫色边框(**不可通过 setType 创建**) |
|
|
31
|
+
|
|
32
|
+
### 闪卡机制
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
闪卡由 Rem 的 \`type\`、\`backText\`、\`practiceDirection\` 三个字段控制。
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
**禁止**:在文本中插入分隔符(\`::\`、\`;;\`、\`>>\` 等)来创建闪卡。分隔符是 RemNote 编辑器语法,工具端无法识别。
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
#### 创建/修改闪卡
|
|
39
39
|
|
|
40
40
|
| 闪卡操作 | 方法 |
|
|
41
|
-
|
|
42
|
-
| 创建概念定义 |
|
|
43
|
-
| 创建正向问答 |
|
|
44
|
-
|
|
|
45
|
-
|
|
|
41
|
+
|:---------|:-----|
|
|
42
|
+
| 创建概念定义 | \`edit_tree\` 新增行 \`概念 ↔ 定义 <!--type:concept-->\` |
|
|
43
|
+
| 创建正向问答 | \`edit_tree\` 新增行 \`问题 → 答案\` |
|
|
44
|
+
| 创建反向问答 | \`edit_tree\` 新增行 \`问题 ← 答案\` |
|
|
45
|
+
| 创建多行答案 | \`edit_tree\` 新增行 \`问题 ↓\`(子行自动成为答案) |
|
|
46
|
+
| 改变闪卡类型/方向 | \`edit_rem\` 修改 \`type\`、\`backText\`、\`practiceDirection\` |
|
|
47
|
+
|
|
48
|
+
\`practiceDirection\` 取值:\`forward\`、\`backward\`、\`both\`、\`none\`。
|
|
49
|
+
|
|
50
|
+
#### 分隔符映射(理解用户意图)
|
|
51
|
+
|
|
52
|
+
用户在编辑器中用分隔符创建闪卡,提到时需映射到工具操作:
|
|
53
|
+
|
|
54
|
+
| 用户说 / 编辑器分隔符 | 对应 type | 对应 practiceDirection |
|
|
55
|
+
|:----------------------|:----------|:----------------------|
|
|
56
|
+
| \`::\` | concept | both |
|
|
57
|
+
| \`;;\` | descriptor | forward |
|
|
58
|
+
| \`>>\` / \`<<\` / \`<>\` | default | forward / backward / both |
|
|
59
|
+
| \`>>>\` / \`::>\` / \`;;>\` | default / concept / descriptor | 多行(子 Rem 为答案) |
|
|
60
|
+
| \`{{}}\` | default | forward(完形填空) |
|
|
61
|
+
|
|
62
|
+
### CDF(Concept-Descriptor Framework)
|
|
46
63
|
|
|
47
|
-
|
|
64
|
+
RemNote 推荐的知识结构化方法——用 Concept 和 Descriptor 构建可自动生成闪卡的知识网络:
|
|
48
65
|
|
|
49
|
-
|
|
66
|
+
- **Concept**(type:concept):核心概念——回答"X 是什么?",文字加粗显示
|
|
67
|
+
- **Descriptor**(type:descriptor):概念的属性——回答"X 的 Y 是什么?"
|
|
50
68
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
69
|
+
在 CLI 大纲中的表现:
|
|
70
|
+
\`\`\`
|
|
71
|
+
线性回归 ↔ 最基本的回归模型 <!--id1 type:concept-->
|
|
72
|
+
假设 → 因变量与自变量呈线性关系 <!--id2 type:descriptor-->
|
|
73
|
+
损失函数 → 均方误差 (MSE) <!--id3 type:descriptor-->
|
|
74
|
+
\`\`\`
|
|
57
75
|
|
|
58
|
-
|
|
76
|
+
CDF 的核心优势:Concept 自动生成双向闪卡("什么是线性回归?"↔"最基本的回归模型"),Descriptor 自动生成正向闪卡("线性回归的假设?"→"因变量与自变量呈线性关系"),层级关系自动维护上下文。
|
|
77
|
+
|
|
78
|
+
### 完形填空(Cloze)
|
|
79
|
+
|
|
80
|
+
通过 RichText 中的 \`cId\` 标记实现(不是分隔符),练习时 \`cId\` 标记的文本被遮盖:
|
|
81
|
+
|
|
82
|
+
\`\`\`json
|
|
83
|
+
["The ", {"cId": "cloze1", "i": "m", "text": "capital"}, " of France is Paris"]
|
|
84
|
+
\`\`\`
|
|
85
|
+
|
|
86
|
+
通过 \`edit_rem\` 操作 RichText 来创建/修改完形填空——在 \`changes.text\` 数组中为目标文字片段添加 \`cId\` 字段。每个 cloze 需要唯一的 \`cId\` 值。
|
|
59
87
|
|
|
60
88
|
### 链接机制
|
|
61
89
|
|
|
62
90
|
| 机制 | 用户操作 | 说明 |
|
|
63
91
|
|:-----|:---------|:-----|
|
|
64
|
-
| Reference
|
|
65
|
-
| Tag
|
|
66
|
-
| Portal
|
|
92
|
+
| Reference \`[[\` | 文本内引用 | 只是指针,不同步编辑 |
|
|
93
|
+
| Tag \`##\` | 附加标签 | 分类标记 |
|
|
94
|
+
| Portal \`((\` | 嵌入实时视图 | **编辑同步**,大纲中标为 \`type:portal\` |
|
|
67
95
|
|
|
68
|
-
|
|
96
|
+
#### Portal 操作速查
|
|
69
97
|
|
|
70
98
|
| 操作 | 命令 | 方式 |
|
|
71
99
|
|:-----|:-----|:-----|
|
|
72
|
-
| 创建 Portal |
|
|
73
|
-
| 删除 Portal |
|
|
74
|
-
|
|
|
75
|
-
| 移动 Portal
|
|
76
|
-
| 读取 Portal |
|
|
100
|
+
| 创建 Portal | \`edit_tree\` | 新增行 \`<!--portal refs:id1,id2-->\` |
|
|
101
|
+
| 删除 Portal | \`edit_tree\` | 从大纲中移除 Portal 行 |
|
|
102
|
+
| 修改引用列表 | \`edit_rem\` | 修改 \`portalDirectlyIncludedRem\` 数组 |
|
|
103
|
+
| 移动 Portal | \`edit_tree\` | 与移动普通行相同 |
|
|
104
|
+
| 读取 Portal | \`read_rem\` | 自动输出 8 字段简化 JSON |
|
|
77
105
|
|
|
78
106
|
### Powerup 过滤
|
|
79
107
|
|
|
80
|
-
RemNote
|
|
108
|
+
RemNote 格式设置(标题、高亮、代码等)底层通过 Powerup 机制实现,会向 Rem 注入隐藏的系统 Tag(\`isPowerup===true\`)和子 Rem(\`isPowerupProperty\`/\`isPowerupSlot\`)。
|
|
109
|
+
|
|
110
|
+
**默认自动过滤**(\`includePowerup=false\`),返回值中 \`powerupFiltered\` 字段统计被过滤的数量(如 \`{tags: 2, children: 3}\`)。
|
|
111
|
+
|
|
112
|
+
\`includePowerup=true\` 参数可恢复完整数据(调试用)。\`read_tree\` 支持此参数,\`read_globe\` 和 \`read_context\` 硬编码过滤。
|
|
113
|
+
|
|
114
|
+
通常无需关心 Powerup 过滤,除非你需要理解某个 Rem 为什么有额外的 children 或 tags。
|
|
81
115
|
|
|
82
116
|
---
|
|
83
117
|
|
|
84
118
|
## 2. Session Lifecycle
|
|
85
119
|
|
|
86
|
-
|
|
120
|
+
所有操作都依赖一个活跃的会话(= 守护进程的生命周期)。
|
|
87
121
|
|
|
88
122
|
### 标准模式(需要用户配合)
|
|
89
123
|
|
|
90
|
-
|
|
91
|
-
connect → 启动 daemon
|
|
124
|
+
\`\`\`
|
|
125
|
+
connect → 启动 daemon(幂等)
|
|
92
126
|
↓
|
|
93
127
|
⚠️ 用户操作:确保 RemNote 中已加载插件(见下方说明)
|
|
94
128
|
↓
|
|
@@ -97,85 +131,70 @@ health → 确认三层就绪(daemon / Plugin / SDK)
|
|
|
97
131
|
业务操作(read / search / edit)
|
|
98
132
|
↓
|
|
99
133
|
disconnect → 关闭 daemon,清空所有缓存
|
|
100
|
-
|
|
134
|
+
\`\`\`
|
|
101
135
|
|
|
102
136
|
### Headless 模式(自动连接)
|
|
103
137
|
|
|
104
|
-
|
|
138
|
+
通过 setup(一次性)+ headless Chrome 实现自动连接,后续 connect 无需用户介入。
|
|
105
139
|
|
|
106
|
-
**⚠️ 模式选择建议**:日常使用推荐**标准模式**。Headless 模式下 Chrome 在后台运行,**无法感知用户正在 RemNote
|
|
140
|
+
**⚠️ 模式选择建议**:日常使用推荐**标准模式**。Headless 模式下 Chrome 在后台运行,**无法感知用户正在 RemNote 中浏览和操作的界面**(\`read_context\` 返回的是 headless Chrome 的上下文,而非用户的浏览器)。只有在全自动化场景才建议使用 Headless 模式。
|
|
107
141
|
|
|
108
142
|
#### 首次使用(setup)
|
|
109
143
|
|
|
110
|
-
|
|
111
|
-
1. **登录 RemNote**
|
|
112
|
-
2. **配置 dev plugin**:插件图标 → 开发你的插件 → 填入 \\\`http://localhost:8080\\\`
|
|
113
|
-
|
|
114
|
-
完成后**彻底退出 Chrome**(macOS 必须 Cmd+Q,仅关窗口不够)。
|
|
144
|
+
\`setup\` 会弹出 Chrome 窗口,用户只需 **登录 RemNote**,然后**彻底退出 Chrome**(macOS 必须 Cmd+Q,仅关窗口不够)。setup 只负责保存登录凭证。
|
|
115
145
|
|
|
116
146
|
**你必须这样与用户交互**:
|
|
117
|
-
1. 调用
|
|
118
|
-
2. 立即告知用户:
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
2. 在 RemNote 中配置开发插件:点击左下角插件图标 → 开发你的插件 → 输入 http://localhost:8080
|
|
122
|
-
3. 完成后彻底退出 Chrome(macOS 请按 Cmd+Q)"
|
|
123
|
-
3. 等待 \\\`setup\\\` 返回(阻塞,最长 10 分钟)
|
|
124
|
-
4. 成功 → 进入下一步 \\\`connect(headless=true)\\\`
|
|
147
|
+
1. 调用 \`setup\`
|
|
148
|
+
2. 立即告知用户:"已打开 Chrome 浏览器。请登录 RemNote,完成后彻底退出 Chrome(macOS 请按 Cmd+Q)"
|
|
149
|
+
3. 等待 \`setup\` 返回(阻塞,最长 10 分钟)
|
|
150
|
+
4. 成功 → 进入下一步 \`connect(headless=true)\`
|
|
125
151
|
|
|
126
|
-
setup 只需执行一次。之后每次连接直接用
|
|
152
|
+
setup 只需执行一次。之后每次连接直接用 \`connect(headless=true)\`。
|
|
127
153
|
|
|
128
154
|
#### 后续使用
|
|
129
155
|
|
|
130
|
-
|
|
156
|
+
\`\`\`
|
|
131
157
|
connect(headless=true) → 启动 daemon + headless Chrome 自动加载 RemNote 和 Plugin
|
|
132
158
|
↓
|
|
133
159
|
health → 等待三层就绪(Plugin 需要 10-30 秒连接,可多次轮询)
|
|
134
160
|
↓
|
|
135
|
-
|
|
161
|
+
业务操作
|
|
136
162
|
↓
|
|
137
163
|
disconnect → 关闭 daemon + headless Chrome,清空所有缓存
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
**无需任何用户操作**——headless Chrome 在后台自动完成登录和 Plugin 加载。
|
|
164
|
+
\`\`\`
|
|
141
165
|
|
|
142
166
|
#### 排查
|
|
143
167
|
|
|
144
|
-
-
|
|
145
|
-
-
|
|
146
|
-
-
|
|
147
|
-
|
|
148
|
-
**关键要点**:
|
|
149
|
-
- \\\`connect\\\` 是所有业务操作的前提,未 connect 时任何命令都会报"守护进程未运行"
|
|
150
|
-
- \\\`health\\\` 检查三层状态:daemon 运行 → Plugin 已连接 → SDK 就绪,三者全部通过才能执行业务命令
|
|
151
|
-
- \\\`disconnect\\\` 会销毁所有缓存,之前的 read 结果全部失效
|
|
152
|
-
- daemon 默认 30 分钟无活动自动关闭
|
|
153
|
-
|
|
154
|
-
### Windows 注意事项
|
|
155
|
-
|
|
156
|
-
- **默认模式秒级启动**:使用预构建 plugin,无需安装依赖
|
|
157
|
-
- **\`--dev\` 模式首次较慢**:会自动安装 remnote-plugin 的依赖(约 600+ 个包),在 Windows 上可能需要 30-60 秒,connect 超时设为 60 秒
|
|
158
|
-
- **\`--dev\` 依赖自动修复**:如果 webpack-dev-server 因依赖损坏而崩溃,daemon 会自动清洁重装依赖(删除 node_modules 后重新安装)并重试,最多重试 2 次
|
|
159
|
-
- **端口残留**:多次 connect 失败后可能出现端口被占用(EADDRINUSE),用 \\\`remnote-bridge disconnect\\\` 或手动终止占用端口的进程后重试
|
|
168
|
+
- \`health(diagnose=true)\`:截图 + Chrome 状态 + console 错误
|
|
169
|
+
- \`health(reload=true)\`:重载 headless Chrome 页面
|
|
170
|
+
- Plugin 始终不连接 → 可能登录 session 过期,需重新 setup
|
|
160
171
|
|
|
161
172
|
### ⚠️ 标准模式:connect 后需要用户配合(重要)
|
|
162
173
|
|
|
163
|
-
|
|
174
|
+
\`connect\`(不传 headless)成功只意味着 daemon 和 Plugin 服务已启动,**Plugin 并未自动连接**。
|
|
164
175
|
|
|
165
176
|
**首次使用**(RemNote 从未加载过此插件):
|
|
166
177
|
1. 打开 RemNote 桌面端或网页端
|
|
167
178
|
2. 点击左侧边栏底部的插件图标(拼图形状)
|
|
168
179
|
3. 点击「开发你的插件」(Develop Your Plugin)
|
|
169
|
-
4. 在输入框中填入
|
|
180
|
+
4. 在输入框中填入 connect 输出的 Plugin 服务地址(如 \`http://localhost:29101\`)
|
|
170
181
|
5. 等待插件加载完成
|
|
171
182
|
|
|
172
183
|
**非首次使用**(之前已加载过此插件):
|
|
173
|
-
- 只需**刷新 RemNote 页面**即可(浏览器 F5 或 Cmd+R
|
|
184
|
+
- 只需**刷新 RemNote 页面**即可(浏览器 F5 或 Cmd+R)
|
|
185
|
+
|
|
186
|
+
**你必须**:执行 \`connect\` 后,**立即告知用户需要完成上述操作**,不要直接调用业务命令。引导用户完成后,用 \`health\` 确认三层就绪再继续。
|
|
187
|
+
|
|
188
|
+
### Windows 注意事项
|
|
189
|
+
|
|
190
|
+
- 默认模式秒级启动(预构建 plugin)
|
|
191
|
+
- 端口残留:多次 connect 失败后可能 EADDRINUSE,用 \`disconnect\` 或手动终止进程后重试
|
|
174
192
|
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
193
|
+
### 关键要点
|
|
194
|
+
|
|
195
|
+
- daemon 默认 **30 分钟**无活动自动关闭,每次请求重置计时器
|
|
196
|
+
- \`disconnect\` 会销毁所有缓存,之前的 read 结果全部失效
|
|
197
|
+
- \`health\` 检查 daemon → Plugin → SDK 链式依赖,三者全通过才能执行业务命令
|
|
179
198
|
|
|
180
199
|
---
|
|
181
200
|
|
|
@@ -183,96 +202,147 @@ disconnect → 关闭 daemon + headless Chrome,清空所有缓存
|
|
|
183
202
|
|
|
184
203
|
### 场景 A:探索知识库
|
|
185
204
|
|
|
186
|
-
>
|
|
205
|
+
> "帮我看看知识库里有什么"、"有哪些文档"
|
|
187
206
|
|
|
188
|
-
|
|
207
|
+
\`read_globe\` → 返回所有 Document 的层级鸟瞰图 → 拿到感兴趣的 remId 后用 \`read_tree\` 深入。
|
|
189
208
|
|
|
190
209
|
### 场景 B:搜索并深入
|
|
191
210
|
|
|
192
|
-
>
|
|
211
|
+
> "搜一下关于 X 的笔记"
|
|
193
212
|
|
|
194
|
-
|
|
195
|
-
- 用 \\\`read_rem\\\` 查看某条结果的详细属性
|
|
196
|
-
- 用 \\\`read_tree\\\` 展开某条结果的子树结构
|
|
213
|
+
\`search\` → 获得匹配 Rem 列表 → \`read_rem\`/\`read_tree\` 查看详情。
|
|
197
214
|
|
|
198
|
-
|
|
215
|
+
**中文搜索限制**:SDK 全文搜索基于空格分词,中文等无空格语言效果差。策略:先用完整词搜索 → 无结果则用单个最具区分度的字重试 → 仍无结果则改用 \`read_globe\` → \`read_tree\` 手动定位。RAG 模式(启用 remnote-rag addon)对中文支持更好。
|
|
199
216
|
|
|
200
|
-
### 场景 C:了解当前上下文(⚠️
|
|
217
|
+
### 场景 C:了解当前上下文(⚠️ 主动调用时机)
|
|
201
218
|
|
|
202
|
-
>
|
|
219
|
+
> "我现在在看什么"、"当前页面"
|
|
203
220
|
|
|
204
|
-
|
|
205
|
-
-
|
|
206
|
-
-
|
|
207
|
-
-
|
|
208
|
-
- 用户似乎在引用他正在查看的界面
|
|
221
|
+
**用户正在看的页面对你不可见。** 当你发现以下情况时,**必须主动调用 \`read_context\`**:
|
|
222
|
+
- 用户提到"这个"、"当前页面"、"这里"等无上下文的指代
|
|
223
|
+
- 用户的描述与你已知信息对不上
|
|
224
|
+
- 搜索不到用户提到的内容
|
|
209
225
|
|
|
210
|
-
|
|
226
|
+
\`read_context\`:focus 模式(默认)以用户焦点为中心构建鱼眼视图;page 模式以当前页面为根展开。两者都返回面包屑路径。
|
|
211
227
|
|
|
212
|
-
|
|
213
|
-
- **focus 模式**(默认):以用户当前光标所在的 Rem 为中心,构建鱼眼视图——焦点处完全展开,周围递减。焦点行以 \\\`* \\\` 前缀标记。需要用户在 RemNote 中已点击某个 Rem。可通过 \\\`focusRemId\\\` 指定任意 Rem 作为鱼眼中心,此时不依赖用户焦点。
|
|
214
|
-
- **page 模式**:以当前打开的页面为根,均匀展开子树。
|
|
228
|
+
### 场景 D:修改文本或属性
|
|
215
229
|
|
|
216
|
-
|
|
230
|
+
> "把标题改成..."、"改成概念"、"加个高亮"
|
|
217
231
|
|
|
218
|
-
|
|
232
|
+
\`read_rem\` → 确认当前属性 → \`edit_rem\` 传入 changes 对象。只需包含要修改的字段,未提及字段保持不变。
|
|
219
233
|
|
|
220
|
-
|
|
234
|
+
#### edit_rem changes 示例
|
|
221
235
|
|
|
222
|
-
|
|
236
|
+
\`\`\`jsonc
|
|
237
|
+
// 修改类型
|
|
238
|
+
changes: { "type": "concept" }
|
|
239
|
+
// 设置整行高亮背景色
|
|
240
|
+
changes: { "highlightColor": "Yellow" }
|
|
241
|
+
// 粗体文本(RichText 数组)
|
|
242
|
+
changes: { "text": [{"b": true, "i": "m", "text": "粗体标题"}] }
|
|
243
|
+
// 超链接(注意用 iUrl 不是 url)
|
|
244
|
+
changes: { "text": ["点击", {"i": "m", "iUrl": "https://remnote.com", "text": "访问官网"}] }
|
|
245
|
+
// 文字颜色(tc 是数字,RemColor 枚举)
|
|
246
|
+
changes: { "text": [{"i": "m", "tc": 1, "text": "红色文字"}] }
|
|
247
|
+
// 批量修改多个字段
|
|
248
|
+
changes: { "type": "concept", "highlightColor": "Yellow", "fontSize": "H1" }
|
|
249
|
+
\`\`\`
|
|
223
250
|
|
|
224
|
-
|
|
225
|
-
2. 在返回的 JSON 文本中定位要修改的部分
|
|
226
|
-
3. \\\`edit_rem\\\` 用 str_replace 替换:oldStr 精确匹配原文,newStr 是修改后的文本
|
|
251
|
+
#### highlightColor(Rem 级别)vs h(RichText 行内)
|
|
227
252
|
|
|
228
|
-
|
|
253
|
+
| 属性 | 位置 | 值类型 | 效果 | 修改方式 |
|
|
254
|
+
|:-----|:-----|:-------|:-----|:---------|
|
|
255
|
+
| \`highlightColor\` | RemObject 顶层 | 字符串 \`"Red"\`/\`"Yellow"\` 等或 \`null\` | 整行背景色 | changes 直接设置 |
|
|
256
|
+
| \`h\` | RichText 元素内 | 数字 0-9(RemColor 枚举) | 文字片段荧光底色 | changes.text 整体替换 |
|
|
229
257
|
|
|
230
|
-
|
|
258
|
+
两者完全独立,互不影响。
|
|
231
259
|
|
|
232
|
-
RichText
|
|
260
|
+
#### RichText h 颜色值对照表
|
|
233
261
|
|
|
234
|
-
|
|
262
|
+
| 值 | 颜色 | 值 | 颜色 | 值 | 颜色 |
|
|
263
|
+
|:---|:-----|:---|:-----|:---|:-----|
|
|
264
|
+
| 0 | 无/默认 | 4 | Green | 7 | Gray |
|
|
265
|
+
| 1 | Red | 5 | Purple | 8 | Brown |
|
|
266
|
+
| 2 | Orange | 6 | Blue | 9 | Pink |
|
|
267
|
+
| 3 | Yellow | — | — | — | — |
|
|
235
268
|
|
|
236
|
-
|
|
237
|
-
oldStr: "text": [\\n "普通标题"\\n ]
|
|
238
|
-
newStr: "text": [\\n {\\n "b": true,\\n "i": "m",\\n "text": "粗体标题"\\n }\\n ]
|
|
239
|
-
\\\`\\\`\\\`
|
|
269
|
+
#### 特殊字段处理规则
|
|
240
270
|
|
|
241
|
-
|
|
271
|
+
- **tags / sources**:传入**目标 ID 数组**,系统自动计算 diff(逐项 add/remove),不是整体替换。必须列出完整目标数组,缺少的 ID 会被删除
|
|
272
|
+
- **backText**:\`null\` → 清除背面(调用 \`setBackText([])\`);传 RichText 数组设置背面内容;裸字符串自动包装为 \`[string]\`
|
|
273
|
+
- **parent + positionAmongstSiblings**:共享同一 SDK 调用 \`setParent(parentId, position)\`,应在同一次 changes 中同时修改
|
|
274
|
+
- **portalDirectlyIncludedRem**:仅 type=portal 的 Rem 可修改,传目标 ID 数组,系统自动 diff(逐项 addToPortal/removeFromPortal)
|
|
275
|
+
- **highlightColor**:\`null\` → 调用 \`removePowerup('h')\`(SDK 不接受 null)
|
|
276
|
+
- **fontSize**:\`null\` → 调用 \`setFontSize(undefined)\`(恢复普通大小)
|
|
277
|
+
- **todoStatus**:依赖 \`isTodo=true\` 才生效;清除 todo 应设 \`isTodo=false\`
|
|
278
|
+
- **type**:不可设为 \`portal\`(Portal 只能通过 SDK \`createPortal()\` 或 edit_tree \`<!--portal-->\` 创建)
|
|
242
279
|
|
|
243
|
-
|
|
244
|
-
oldStr: "text": [\\n "点击访问官网"\\n ]
|
|
245
|
-
newStr: "text": [\\n "点击",\\n {\\n "i": "m",\\n "iUrl": "https://remnote.com",\\n "text": "访问官网"\\n }\\n ]
|
|
246
|
-
\\\`\\\`\\\`
|
|
280
|
+
### 场景 E:修改结构(新增/删除/移动/重排)
|
|
247
281
|
|
|
248
|
-
|
|
282
|
+
> "在这下面加几个子项"、"删掉这个"
|
|
249
283
|
|
|
250
|
-
|
|
284
|
+
\`read_tree\` → 查看大纲 → \`edit_tree\` 用 str_replace 修改。
|
|
251
285
|
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
| \\\`read_tree\\\` | 写入缓存 | 供 \\\`edit_tree\\\` 使用 |
|
|
256
|
-
| \\\`search\\\` / \\\`read_globe\\\` / \\\`read_context\\\` | **不缓存** | 不能作为 edit 前置 |
|
|
286
|
+
**关键红线**:
|
|
287
|
+
- edit_tree **禁止修改行内容**(改内容用 edit_rem)
|
|
288
|
+
- 新增行必须插在兄弟**末尾**,不能插在有子节点的 Rem 和其 children 之间(否则触发 \`children_captured\`)
|
|
257
289
|
|
|
258
|
-
|
|
290
|
+
#### 新增行格式说明
|
|
291
|
+
|
|
292
|
+
新增行(无 remId 注释的行)支持以下格式:
|
|
293
|
+
|
|
294
|
+
**Markdown 前缀**:\`# \` \`## \` \`### \` \`- [ ] \` \`- [x] \` \\\`code\\\` \`---\`
|
|
295
|
+
|
|
296
|
+
**箭头分隔符**:
|
|
297
|
+
- 单行:\`→\`(forward)\`←\`(backward)\`↔\`(both)——格式 \`text → backText\`
|
|
298
|
+
- 多行:\`↓\`(forward)\`↑\`(backward)\`↕\`(both)——子行自动成为答案
|
|
299
|
+
|
|
300
|
+
**元数据注释**(可选,行尾追加):
|
|
301
|
+
- \`<!--type:concept-->\` \`<!--type:descriptor-->\` \`<!--doc-->\`
|
|
302
|
+
- \`<!--tag:标签名(tagId)-->\`(可多个,空格分隔)
|
|
303
|
+
- 可组合:\`<!--type:concept doc tag:数学(tag01)-->\`
|
|
304
|
+
|
|
305
|
+
**Portal 新增**:
|
|
306
|
+
- \`<!--portal refs:id1,id2-->\`(创建并引用指定 Rem)
|
|
307
|
+
- \`<!--portal-->\`(创建空 Portal)
|
|
308
|
+
|
|
309
|
+
#### str_replace 构造示例
|
|
259
310
|
|
|
260
|
-
|
|
311
|
+
**示例 1:在末尾新增行**
|
|
312
|
+
\`\`\`
|
|
313
|
+
oldStr:
|
|
314
|
+
最后一个兄弟 <!--idZ-->
|
|
315
|
+
newStr:
|
|
316
|
+
最后一个兄弟 <!--idZ-->
|
|
317
|
+
新增行
|
|
318
|
+
\`\`\`
|
|
261
319
|
|
|
262
|
-
|
|
320
|
+
**示例 2:删除一个带子节点的行(必须一起删)**
|
|
321
|
+
\`\`\`
|
|
322
|
+
oldStr:
|
|
323
|
+
子节点 A <!--idA-->
|
|
324
|
+
孙节点 A1 <!--idA1-->
|
|
325
|
+
子节点 B <!--idB-->
|
|
326
|
+
newStr:
|
|
327
|
+
子节点 B <!--idB-->
|
|
328
|
+
\`\`\`
|
|
263
329
|
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
330
|
+
**示例 3:创建多行闪卡**
|
|
331
|
+
\`\`\`
|
|
332
|
+
oldStr:
|
|
333
|
+
子节点 A <!--idA-->
|
|
334
|
+
newStr:
|
|
335
|
+
什么是线性回归? ↓
|
|
336
|
+
一种基本的回归分析方法
|
|
337
|
+
假设因变量与自变量呈线性关系
|
|
338
|
+
子节点 A <!--idA-->
|
|
339
|
+
\`\`\`
|
|
270
340
|
|
|
271
|
-
|
|
341
|
+
#### ⚠️ children_captured 详解
|
|
272
342
|
|
|
273
|
-
|
|
343
|
+
在有子节点的 Rem 和其 children 之间插入新行,会导致新行"劫持"已有 children:
|
|
274
344
|
|
|
275
|
-
|
|
345
|
+
\`\`\`
|
|
276
346
|
❌ 错误:插在父 Rem 和 children 之间
|
|
277
347
|
oldStr: 水分子 ↓ <!--idA-->
|
|
278
348
|
newStr: 水分子 ↓ <!--idA-->
|
|
@@ -282,40 +352,44 @@ newStr: 水分子 ↓ <!--idA-->
|
|
|
282
352
|
oldStr: 最后一个兄弟 <!--idZ-->
|
|
283
353
|
newStr: 最后一个兄弟 <!--idZ-->
|
|
284
354
|
新行
|
|
285
|
-
|
|
355
|
+
\`\`\`
|
|
286
356
|
|
|
287
|
-
|
|
288
|
-
1. 第一次 \\\`edit_tree\\\`:在末尾创建新节点(获得 remId)
|
|
289
|
-
2. 第二次 \\\`edit_tree\\\`:把已有行移动到新节点下面(此时新节点已有 remId,走正常 move 逻辑)
|
|
357
|
+
#### 创建新节点并移动已有 children
|
|
290
358
|
|
|
291
|
-
|
|
359
|
+
当需要在已有 children 的 Rem 下插入一个新的中间层时,不能一步完成(否则触发 children_captured)。正确做法是**两步**:
|
|
292
360
|
|
|
293
|
-
|
|
361
|
+
1. 先在大纲**末尾**新增节点(避免劫持)
|
|
362
|
+
2. 再发一次 \`edit_tree\`,将已有 children 移动到新节点下(通过调整缩进实现移动)
|
|
294
363
|
|
|
295
|
-
|
|
364
|
+
### 场景 F:创建/修改闪卡
|
|
296
365
|
|
|
297
|
-
|
|
298
|
-
- 正向问答:\\\`问题 → 答案\\\`
|
|
299
|
-
- 双向问答:\\\`问题 ↔ 答案\\\`
|
|
300
|
-
- 多行答案:\\\`问题 ↓\\\`(子行自动成为答案)
|
|
301
|
-
- 概念定义:\\\`概念 ↔ 定义 <!--type:concept-->\\\`(一步完成,无需再 edit_rem)
|
|
302
|
-
- 描述属性:\\\`属性 → 值 <!--type:descriptor-->\\\`
|
|
366
|
+
> "创建概念定义"、"做个正向问答卡"
|
|
303
367
|
|
|
304
|
-
|
|
305
|
-
-
|
|
306
|
-
-
|
|
307
|
-
-
|
|
368
|
+
**创建新闪卡**(\`edit_tree\` 新增行 + 箭头 + 可选元数据注释):
|
|
369
|
+
- 正向:\`问题 → 答案\`
|
|
370
|
+
- 双向:\`问题 ↔ 答案\`
|
|
371
|
+
- 多行:\`问题 ↓\`(子行自动成为答案)
|
|
372
|
+
- 概念定义:\`概念 ↔ 定义 <!--type:concept-->\`(一步完成)
|
|
373
|
+
- 描述属性:\`属性 → 值 <!--type:descriptor-->\`(与 Concept 配合使用)
|
|
308
374
|
|
|
309
|
-
|
|
375
|
+
**Concept vs Descriptor 使用场景**:
|
|
376
|
+
- Concept(概念定义):独立的核心概念,回答"X 是什么?"——如"线性回归 ↔ 最基本的回归模型"
|
|
377
|
+
- Descriptor(描述属性):作为某个 Concept 的子 Rem,回答"X 的 Y 是什么?"——如"假设 → 因变量与自变量呈线性关系"
|
|
378
|
+
- 通常 Descriptor 是 Concept 的直接子节点,二者配合构成完整的 CDF 知识结构
|
|
379
|
+
|
|
380
|
+
**修改现有 Rem 的闪卡行为**(\`read_rem\` → \`edit_rem\`):修改 \`type\`、\`practiceDirection\`、\`backText\` 字段。
|
|
310
381
|
|
|
311
382
|
### 场景 G:排查连接问题
|
|
312
383
|
|
|
313
|
-
|
|
384
|
+
\`health\` 检查三层状态:daemon 未运行 → \`connect\`;Plugin 未连接 → 引导用户操作 RemNote;SDK 未就绪 → 等待重试。
|
|
385
|
+
|
|
386
|
+
### 场景 H:管理增强项目
|
|
387
|
+
|
|
388
|
+
\`addon\`:\`action="list"\` 查看状态、\`action="install"\` 安装、\`action="uninstall"\` 卸载。
|
|
314
389
|
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
- SDK 未就绪 → 等待几秒后重试 health
|
|
390
|
+
### 场景 I:重置环境
|
|
391
|
+
|
|
392
|
+
\`clean\` 彻底清理所有 daemon 进程、PID 文件、注册表和 addon 数据。清理后需重新 \`connect\`。
|
|
319
393
|
|
|
320
394
|
---
|
|
321
395
|
|
|
@@ -323,88 +397,222 @@ newStr: 最后一个兄弟 <!--idZ-->
|
|
|
323
397
|
|
|
324
398
|
### 黄金法则:先 read 再 edit
|
|
325
399
|
|
|
326
|
-
-
|
|
327
|
-
-
|
|
400
|
+
- \`edit_rem\` 前必须先 \`read_rem\` 同一个 remId
|
|
401
|
+
- \`edit_tree\` 前必须先 \`read_tree\` 同一个 remId
|
|
402
|
+
- \`search\`/\`read_globe\`/\`read_context\` **不写入缓存**,不能作为 edit 前置
|
|
328
403
|
|
|
329
|
-
跳过 read 直接 edit
|
|
404
|
+
跳过 read 直接 edit 会被拒绝(硬性要求)。
|
|
330
405
|
|
|
331
|
-
###
|
|
406
|
+
### 两道防线
|
|
332
407
|
|
|
333
|
-
每次 edit 操作都经过三重安全检查:
|
|
334
408
|
1. **缓存存在**:必须有对应的 read 缓存
|
|
335
|
-
2. **并发检测**:edit
|
|
336
|
-
3. **精确匹配**:oldStr 必须在目标文本中恰好匹配 1 次
|
|
409
|
+
2. **并发检测**:edit 时重新读取最新数据与缓存比较,Rem 被外部修改则拒绝——必须重新 read
|
|
337
410
|
|
|
338
411
|
### edit_tree 禁止事项
|
|
339
412
|
|
|
340
|
-
-
|
|
341
|
-
-
|
|
342
|
-
-
|
|
343
|
-
-
|
|
344
|
-
-
|
|
345
|
-
|
|
346
|
-
|
|
413
|
+
- \`content_modified\`:修改已有行内容 → 用 edit_rem
|
|
414
|
+
- \`root_modified\`:删除/修改根节点
|
|
415
|
+
- \`folded_delete\`:删除有隐藏子节点的行 → 更大 depth 重新 read_tree
|
|
416
|
+
- \`orphan_detected\`:删父留子 → 必须一起删
|
|
417
|
+
- \`elided_modified\`:修改/删除省略占位符 → 更大参数重新 read_tree
|
|
418
|
+
- \`children_captured\`:新行劫持已有子节点 → 插在兄弟末尾
|
|
419
|
+
- \`indent_skip\`:缩进跳级 → 每级 2 空格
|
|
420
|
+
|
|
421
|
+
### 缓存行为速查表
|
|
422
|
+
|
|
423
|
+
| 场景 | 缓存行为 | 重试策略 |
|
|
424
|
+
|:-----|:---------|:---------|
|
|
425
|
+
| edit_rem 写入成功 | 从 Plugin 重新读取 → 更新缓存 | 可继续编辑 |
|
|
426
|
+
| edit_rem 防线拒绝/部分失败 | 不更新缓存 | 必须重新 read_rem |
|
|
427
|
+
| edit_tree 成功 | 自动 re-read → 更新缓存 | 可连续 edit |
|
|
428
|
+
| edit_tree 防线 3 拒绝(str_replace 不匹配等) | 缓存保持不变 | 调整 oldStr/newStr 后直接重试 |
|
|
429
|
+
| edit_tree 执行中异常 | 已执行操作保留(**无回滚**),不更新缓存 | 必须重新 read_tree |
|
|
430
|
+
| 枚举值非法(edit_rem) | 报错拒绝,缓存不变 | 检查允许的值范围后重试 |
|
|
431
|
+
|
|
432
|
+
### 可写字段列表(21 个)
|
|
433
|
+
|
|
434
|
+
\`\`\`
|
|
435
|
+
text, backText, type, isDocument, parent,
|
|
436
|
+
fontSize, highlightColor,
|
|
437
|
+
isTodo, todoStatus, isCode, isQuote, isListItem, isCardItem, isSlot, isProperty,
|
|
438
|
+
enablePractice, practiceDirection,
|
|
439
|
+
tags, sources, positionAmongstSiblings, portalDirectlyIncludedRem
|
|
440
|
+
\`\`\`
|
|
441
|
+
|
|
442
|
+
### 枚举约束速查
|
|
443
|
+
|
|
444
|
+
| 字段 | 允许的值 |
|
|
445
|
+
|:-----|:---------|
|
|
446
|
+
| \`type\` | \`concept\` / \`descriptor\` / \`default\`(\`portal\` 不可设置) |
|
|
447
|
+
| \`practiceDirection\` | \`forward\` / \`backward\` / \`both\` / \`none\` |
|
|
448
|
+
| \`highlightColor\` | \`Red\` / \`Orange\` / \`Yellow\` / \`Green\` / \`Blue\` / \`Purple\` / \`Gray\` / \`Brown\` / \`Pink\` / \`null\` |
|
|
449
|
+
| \`fontSize\` | \`H1\` / \`H2\` / \`H3\` / \`null\` |
|
|
450
|
+
| \`todoStatus\` | \`Finished\` / \`Unfinished\` / \`null\`(需先 \`isTodo=true\`) |
|
|
347
451
|
|
|
348
452
|
---
|
|
349
453
|
|
|
350
454
|
## 5. Output Format Quick Reference
|
|
351
455
|
|
|
352
|
-
|
|
456
|
+
\`read_tree\`、\`read_globe\`、\`read_context\` 返回 Markdown 大纲。
|
|
353
457
|
|
|
354
458
|
### 行结构
|
|
355
459
|
|
|
356
|
-
|
|
357
|
-
{缩进}{
|
|
358
|
-
|
|
460
|
+
\`\`\`
|
|
461
|
+
{缩进}{前缀}{内容}{箭头}{backText} <!-- {remId} {标记} -->
|
|
462
|
+
\`\`\`
|
|
359
463
|
|
|
360
464
|
- 缩进:每级 2 空格
|
|
361
|
-
-
|
|
465
|
+
- 前缀:\`# \`(H1)、\`## \`(H2)、\`### \`(H3)、\`- [ ] \`(待办)、\`- [x] \`(已完成)、\\\`...\\\`(代码)、\`---\`(分隔线)
|
|
362
466
|
|
|
363
|
-
###
|
|
467
|
+
### 元数据标记
|
|
364
468
|
|
|
365
469
|
| 标记 | 含义 |
|
|
366
470
|
|:-----|:-----|
|
|
367
|
-
|
|
|
368
|
-
|
|
|
369
|
-
|
|
|
370
|
-
|
|
|
371
|
-
|
|
|
372
|
-
|
|
|
471
|
+
| \`type:concept\` / \`type:descriptor\` / \`type:portal\` | Rem 类型(default 不标记) |
|
|
472
|
+
| \`doc\` | 是文档页面 |
|
|
473
|
+
| \`top\` | 知识库顶层 Rem |
|
|
474
|
+
| \`children:N\` | 有 N 个未展开的子节点 |
|
|
475
|
+
| \`role:card-item\` | 多行闪卡答案行 |
|
|
476
|
+
| \`tag:Name(id)\` | 已附加的标签 |
|
|
477
|
+
| \`refs:id1,id2\` | Portal 引用的 Rem ID |
|
|
373
478
|
|
|
374
479
|
### 箭头含义
|
|
375
480
|
|
|
376
|
-
|
|
377
|
-
|
|
481
|
+
| 箭头 | practiceDirection | 格式 |
|
|
482
|
+
|:-----|:------------------|:-----|
|
|
483
|
+
| \`→\` \`←\` \`↔\` | forward / backward / both | \`text → backText\`(单行) |
|
|
484
|
+
| \`↓\` \`↑\` \`↕\` | forward / backward / both | \`text ↓\` 或 \`text ↓ backText\`(多行,子行为答案) |
|
|
378
485
|
|
|
379
486
|
### 省略占位符
|
|
380
487
|
|
|
381
|
-
|
|
382
|
-
<!--...elided 3 siblings (parent:
|
|
383
|
-
<!--...elided >=10 nodes (parent:
|
|
384
|
-
|
|
488
|
+
\`\`\`
|
|
489
|
+
<!--...elided 3 siblings (parent:id range:2-4 total:5)--> 精确省略(超 maxSiblings)
|
|
490
|
+
<!--...elided >=10 nodes (parent:id range:5-14 total:20)--> 非精确省略(maxNodes 耗尽)
|
|
491
|
+
\`\`\`
|
|
492
|
+
|
|
493
|
+
精确省略保留前 70% + 后 30%。**省略占位符不可删除或修改**。
|
|
494
|
+
|
|
495
|
+
### edit_tree 新增行格式
|
|
496
|
+
|
|
497
|
+
新增行(无 remId 注释的行)在 newStr 中出现时,会被创建为新的 Rem。格式选项:
|
|
498
|
+
|
|
499
|
+
- 纯文本行:\`新内容\`
|
|
500
|
+
- 带前缀:\`# 新标题\`、\`- [ ] 新待办\`
|
|
501
|
+
- 带箭头:\`问题 → 答案\`、\`概念 ↔ 定义\`、\`题目 ↓\`
|
|
502
|
+
- 带元数据注释(metadata-only,无 remId):\`新行 <!--type:concept doc-->\`
|
|
503
|
+
- Portal 行:\`<!--portal refs:id1,id2-->\`
|
|
504
|
+
- 嵌套新增(父+子一起创建):
|
|
505
|
+
\`\`\`
|
|
506
|
+
新父节点 ↓
|
|
507
|
+
新子行 1
|
|
508
|
+
新子行 2
|
|
509
|
+
\`\`\`
|
|
510
|
+
|
|
511
|
+
### 完整示例大纲
|
|
512
|
+
|
|
513
|
+
\`\`\`markdown
|
|
514
|
+
# 数据结构 <!--kLr type:concept doc top-->
|
|
515
|
+
## 线性结构 <!--ABC type:concept-->
|
|
516
|
+
数组 → Array <!--DEF-->
|
|
517
|
+
链表 ↓ <!--GHI type:concept-->
|
|
518
|
+
单向链表 <!--JKL role:card-item-->
|
|
519
|
+
双向链表 <!--MNO role:card-item-->
|
|
520
|
+
- [x] 复习完成 <!--PQR-->
|
|
521
|
+
## 树结构 <!--VWX type:concept children:8-->
|
|
522
|
+
<!--...elided 3 siblings (parent:kLr range:3-5 total:6)-->
|
|
523
|
+
嵌入视图 <!--p01 type:portal refs:ref1,ref2-->
|
|
524
|
+
重要概念 <!--QRS tag:数学(tag01) tag:基础(tag02)-->
|
|
525
|
+
\`\`\`
|
|
526
|
+
|
|
527
|
+
---
|
|
528
|
+
|
|
529
|
+
## 6. RichText 格式参考
|
|
530
|
+
|
|
531
|
+
\`text\` 和 \`backText\` 字段是 JSON 数组(RichText),元素为纯字符串或格式化对象。
|
|
385
532
|
|
|
386
|
-
|
|
533
|
+
### 元素类型表
|
|
387
534
|
|
|
388
|
-
|
|
535
|
+
| \`i\` 值 | 含义 | 必填字段 | 可选字段 |
|
|
536
|
+
|:---------|:-----|:---------|:---------|
|
|
537
|
+
| (纯 string) | 纯文本片段 | — | — |
|
|
538
|
+
| \`"m"\` | 带格式文本 | \`text\` | \`b\`, \`l\`, \`u\`, \`h\`, \`tc\`, \`q\`, \`code\`, \`language\`, \`cId\`, \`iUrl\` |
|
|
539
|
+
| \`"q"\` | Rem 引用 | \`_id\` | \`content\`, \`showFullName\`, \`aliasId\` |
|
|
540
|
+
| \`"i"\` | 图片 | \`url\` | \`width\`, \`height\`, \`percent\`(25/50/100) |
|
|
541
|
+
| \`"x"\` | LaTeX | \`text\` | \`block\`(true=块级公式) |
|
|
542
|
+
| \`"a"\` | 音频/视频 | \`url\`, \`onlyAudio\`(**必填**) | \`width\`, \`height\` |
|
|
543
|
+
| \`"s"\` | 卡片分隔符 | — | \`delimiterCharacterForSerialization\` |
|
|
544
|
+
|
|
545
|
+
### 格式标记表(\`i:"m"\` 主要,但 \`i:"q"\` 等也支持部分标记)
|
|
546
|
+
|
|
547
|
+
| 字段 | 类型 | 含义 |
|
|
548
|
+
|:-----|:-----|:-----|
|
|
549
|
+
| \`b\` | \`true\` | 加粗 |
|
|
550
|
+
| \`l\` | \`true\` | 斜体(小写 L,不是大写 I) |
|
|
551
|
+
| \`u\` | \`true\` | 下划线 |
|
|
552
|
+
| \`h\` | number | 高亮颜色(RemColor 0-9) |
|
|
553
|
+
| \`tc\` | number | 文字颜色(RemColor 0-9) |
|
|
554
|
+
| \`q\` | \`true\` | 行内代码(红色等宽样式) |
|
|
555
|
+
| \`code\` | \`true\` | 代码块(带语言标签和复制按钮) |
|
|
556
|
+
| \`language\` | string | 代码语言(如 \`"python"\`) |
|
|
557
|
+
| \`cId\` | string | 完形填空 ID |
|
|
558
|
+
| \`hiddenCloze\` | \`true\` | 完形填空隐藏状态 |
|
|
559
|
+
| \`iUrl\` | string | 超链接 URL(**不是 \`url\`!**) |
|
|
560
|
+
| \`qId\` | string | 行内引用的 Rem ID |
|
|
561
|
+
|
|
562
|
+
### RemColor 颜色枚举(\`h\` 和 \`tc\` 共用)
|
|
563
|
+
|
|
564
|
+
| 值 | 颜色 | 值 | 颜色 | 值 | 颜色 |
|
|
565
|
+
|:---|:-----|:---|:-----|:---|:-----|
|
|
566
|
+
| 0 | 无/默认 | 4 | Green | 7 | Gray |
|
|
567
|
+
| 1 | Red | 5 | Purple | 8 | Brown |
|
|
568
|
+
| 2 | Orange | 6 | Blue | 9 | Pink |
|
|
569
|
+
| 3 | Yellow | — | — | — | — |
|
|
570
|
+
|
|
571
|
+
### 常用构造示例(key 字母序排列)
|
|
572
|
+
|
|
573
|
+
\`\`\`jsonc
|
|
574
|
+
{"b": true, "i": "m", "text": "粗体"} // 粗体
|
|
575
|
+
{"i": "m", "q": true, "text": "code"} // 行内代码
|
|
576
|
+
{"i": "m", "iUrl": "https://...", "text": "链接"} // 超链接(iUrl 不是 url!)
|
|
577
|
+
{"b": true, "h": 1, "i": "m", "text": "重点"} // 粗体+红色高亮
|
|
578
|
+
{"cId": "c1", "i": "m", "text": "答案"} // 完形填空
|
|
579
|
+
{"_id": "remId", "b": true, "i": "q"} // Rem 引用加粗
|
|
580
|
+
{"i": "x", "text": "E = mc^2"} // LaTeX
|
|
581
|
+
{"i": "a", "onlyAudio": false, "url": "..."} // 视频(onlyAudio 必填!)
|
|
582
|
+
{"i": "a", "onlyAudio": true, "url": "..."} // 音频
|
|
583
|
+
\`\`\`
|
|
584
|
+
|
|
585
|
+
### ⚠️ 关键陷阱
|
|
586
|
+
|
|
587
|
+
- \`i:"a"\` 的 \`onlyAudio\` 是**必填**字段(\`true\`=音频,\`false\`=视频),缺少会导致 SDK 拒绝写入
|
|
588
|
+
- 超链接必须用 \`iUrl\`,\`url\` 字段已废弃无效
|
|
589
|
+
- RichText 对象内部按 **key 字母序排列**(\`_id\` < \`b\` < \`cId\` < \`h\` < \`i\` < \`iUrl\` < \`text\`),确保序列化一致性
|
|
590
|
+
- \`highlightColor\`(RemObject 顶层,字符串 \`"Red"\`)与 \`h\`(RichText 内部,数字 \`1\`)完全独立——前者是整行背景色,后者是文字片段荧光底色
|
|
591
|
+
- 防线 2(乐观并发检测)依赖 key 字母序的确定性序列化来比较缓存与最新数据
|
|
389
592
|
|
|
390
593
|
---
|
|
391
594
|
|
|
392
|
-
##
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
595
|
+
## 7. Error Quick Reference
|
|
596
|
+
|
|
597
|
+
### 诊断决策树
|
|
598
|
+
|
|
599
|
+
\`\`\`
|
|
600
|
+
命令报错
|
|
601
|
+
├─ "守护进程未运行" → connect 未执行或 daemon 已超时 → 执行 connect
|
|
602
|
+
├─ "Plugin 未连接" → RemNote 未打开或插件未加载 → 引导用户操作 RemNote
|
|
603
|
+
├─ "SDK 未就绪" → 知识库尚未加载 → 等待并重试 health
|
|
604
|
+
├─ "has not been read yet" → 未先 read → 执行对应 read 后重试
|
|
605
|
+
├─ "has been modified since last read" → 被外部修改 → 必须重新 read(不可直接重试)
|
|
606
|
+
├─ "Invalid value" → 枚举字段值不合法 → 检查允许的值范围
|
|
607
|
+
├─ "old_str not found" → oldStr 不精确 → 检查缩进、空格、换行
|
|
608
|
+
├─ "old_str matches N locations" → oldStr 不够具体 → 扩大范围包含更多上下文
|
|
609
|
+
├─ "content_modified" → edit_tree 中改了行内容 → 用 edit_rem
|
|
610
|
+
├─ "orphan_detected" → 删了父但留了子 → 同时删除所有子行
|
|
611
|
+
├─ "folded_delete" → 删了有隐藏子节点的行 → 更大 depth 重新 read_tree
|
|
612
|
+
├─ "elided_modified" → 删/改了省略占位符 → 更大参数重新 read_tree
|
|
613
|
+
├─ "children_captured" → 新行劫持已有子节点 → 新行插到兄弟末尾
|
|
614
|
+
├─ "indent_skip" → 缩进跳级 → 每级 2 空格不可跳级
|
|
615
|
+
├─ "Rem not found" → remId 无效或已删除 → 用 search 重新定位
|
|
616
|
+
└─ "focusRemId 仅在 focus 模式下有效" → page 模式不支持 → 去掉参数或改用 focus 模式
|
|
617
|
+
\`\`\`
|
|
410
618
|
`;
|