dsh-plugin-zotero 0.4.0 → 0.5.0

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/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # dsh-plugin-zotero
2
2
 
3
- **把 Zotero 文献库映射进 DSH:在同一个界面里精读文献,与 AI 同步作业。**
3
+ **把 Zotero 文献库映射进 DSH:用AI管理操作Zotero,读文献时让AI辅助你。**
4
4
 
5
5
  本插件把 Zotero 的文库结构、元数据、PDF 全文、笔记与标注接入 DSH,将「检索文献 — 精读全文 — 摘录标注 — 与模型讨论 — 形成稿子」收进同一条工作流:右侧栏按分类与标签浏览文库,按标题 / 摘要筛选当前范围,双击条目即在 DSH 内打开独立阅读页,PDF 整页渲染、高亮原位叠加,同一篇文献的原文与译本附件可在页内切换;读到关键段落时可直接划词摘录,或引用该条标注、笔记乃至整篇文献,以引用胶囊写进当前会话草稿,模型随即基于原文接续完成综述、方法对比、数据提取与引文核对。
6
6
 
@@ -21,11 +21,11 @@
21
21
  它能替你做的事,举几个常见例子:
22
22
 
23
23
  - **找文献**:按标题、年份、全文关键词检索,也能跨库搜高亮和批注,快速回答「我收过哪些讲 XX 的文章」;右侧栏里还能按分类、标签和标题 / 摘要逐层缩小范围。
24
- - **读文献**:双击条目就在 DSH 内开独立阅读页,PDF 整页渲染、高亮原位叠加,原文与译本附件随时切换;摘要、全文、笔记与标注都能在这里读完,写综述、做对比、提取数据都行,需要精确引用时会保留原文措辞。
24
+ - **读文献**:双击条目就在 DSH 内开独立阅读页,PDF 整页渲染、高亮原位叠加,原文与译本附件随时切换;摘要、全文、笔记与标注都能在这里读完,写综述、做对比、提取数据都行,需要精确引用时会保留原文措辞。开启写权限后,正文里划选即选颜色落一条高亮或下划线(跨页自动按页拆条)、随手带一句评论,改色、改评论、改页码、加标签、高亮↔划线互转、删除都在同一处;笔记也能新建、编辑、删除。改动直接进 Zotero 库,不是插件里的副本。
25
25
  - **整理文库**:新建、重命名、移动、删除分类,批量把条目加入或移出分类。你说一句「把这几篇归到『待读』里」,它就照做。
26
26
  - **帮你入库**:把本地下载好的论文、PDF 交给 DSH 导入 Zotero;也可以让它读完外文文献后,把译文作为附件挂回条目。
27
27
  - **带进对话**:右侧面板单条目引用、列表多选批量引用、阅读页划词摘录与点高亮引用、单标签或多标签引用、整分类引用,一键写进当前会话草稿(不自动发送),你再接着说要求。条目、标签和整分类以「引用胶囊」的形式出现,草稿里一眼看清引了哪几篇,单独删掉某一条也不影响其他内容。
28
- - **安全可控**:浏览面板严格只读;模型能用的每一项工具都能单独开关,想彻底只读就把写操作关掉;写操作优先走集成 MCP,它在 Zotero 进程内直接执行,不触发本地 API 的授权弹窗。
28
+ - **安全可控**:写能力默认全关 —— 配置卡里「Zotero 写权限」不开启,面板就是纯只读,模型也看不到任何写工具。开启后写操作优先走集成 MCP(在 Zotero 进程内执行,不触发本地 API 授权弹窗),标注与笔记这两类 MCP 覆盖不到的才走本地 API,需要一次性点「始终允许」授权;模型侧每一项工具都能单独开关。
29
29
 
30
30
  面板布局与 Zotero 本体一致:顶部状态栏显示连接状态并提供刷新;左侧是分类树,树下是可拖高、可折叠的标签面板;右侧列表显示当前范围(分类 / 全库 / 标签筛选后)的条目。分类树与条目列表之间的分隔条可拖动,宽度按本机记住。列表里单击条目选中、`Ctrl` / `Cmd` 点选多选,双击才在右侧栏顶层单开一个标签页看详情。阅读页就开在会话旁边的标签里,边读边摘、边问边改,不必在 Zotero 与 AI 两个窗口之间来回切换。
31
31
 
@@ -84,13 +84,15 @@ curl http://127.0.0.1:23119/api/ # 期望输出:Zotero is running
84
84
  - **条目列表**:每行显示文献类型图标与作者 / 年份;读过的文献类型图标转为粉色、标题略淡,悬停补上类型名与最后阅读时间。单击选中、`Ctrl` / `Cmd` 点选多选,双击在右侧栏顶层开独立详情页,右键单行可直接插引用;头部搜索框针对当前范围(分类 / 全库 / 标签筛选后)按标题与摘要过滤,列表可分页「加载更多」,选中多条时右上角一次「引用 N」。
85
85
  - **标签面板**:树下方独立面板,可拖高 / 折叠;标签按 Zotero 的换行胶囊排布并跟随当前目录:选中分类时只列该分类自身条目里出现过的标签(不含子目录,自动标签弱化显示),选中文库根时列出全库标签;可按名称筛选、多选,并切换「全部(AND)/ 任一(OR)」。筛选作用于当前选择的范围,列表头部会显示已选标签胶囊与「清除筛选」;切换目录会自动清除已选标签,避免旧筛选作用到新范围。已选标签可从摘要行合并成一枚「标签组」胶囊引用。
86
86
  - **条目详情独立成页**:双击条目在右侧栏顶层新开一个标签页,同一条目再次双击只回到已有页;详情页可同时开多个,切换标签页时各自的展开状态与滚动位置都保留(正文常驻挂载)。
87
- - **文档优先版面**:详情页整页显示文献本体——PDF 走 PDF.js 渲染(顶部工具栏缩放、页码、当前页在 Zotero 中打开),没有 PDF 时回退到 API 全文文本。左侧固定的 30px 工具栏不遮挡正文。选中正文即浮出「摘录」按钮,点正文里的高亮则弹出标注卡片(类型、原文、「引用」与「在 Zotero 中打开」)。
87
+ - **文档优先版面**:详情页整页显示文献本体——PDF 走 PDF.js 渲染(顶部工具栏缩放、页码、当前页在 Zotero 中打开),没有 PDF 时回退到 API 全文文本。左侧固定的 30px 工具栏不遮挡正文。选中正文即浮出「摘录」按钮,点正文里的高亮则弹出标注卡片(类型、原文、评论,以及「引用」与「在 Zotero 中打开」)。
88
88
  - **左上角信息面板**:点左上角 `i` 按钮弹出浮层,把文献信息 / 摘要 / 标注 / 笔记 / 附件 / 参考文献分块竖排,每块可单独折叠;点浮层外或按 `Esc` 关闭,点标注定位时自动关闭把焦点还给文档。
89
+ - **文档目录**:`i` 左边的列表按钮展开 PDF 自带书签的大纲树,按层级缩进,点一条即跳到对应页(跳完自动收起);没有书签的 PDF 显示「这篇 PDF 没有目录」。Zotero 本地 API 与集成 MCP 都没有目录数据,这份大纲由插件从 PDF 文件里自己解析(上限 8 层 / 800 条)。
89
90
  - **笔记可读**:独立笔记(文库里的全局笔记)打开后正文直接占据文档区,跟普通条目一样阅读;子笔记在信息面板的「笔记」块里折叠呈现,正文保留 Zotero 的引用块、标注高亮、表格与外链图片。Host 侧已清洗脚本与事件属性,避免注入。「引用」把该条笔记转成纯文本写进会话草稿。
90
91
  - **标注可读**:PDF 上的高亮与划线原位叠加在页面上,点页内标注弹出卡片,可当场「引用」或跳回 Zotero 对应页;「标注」块按类型 / 颜色筛选,点条目可跨附件定位、滚动并闪烁,「引用」把该条标注写进会话草稿。
91
92
  - **多种插入方式**:单条目、列表多选批量、单标签、多标签(合并成一枚「标签组」胶囊,AND/OR 在插入那一刻定格)与整目录引用都以「引用胶囊」写进草稿——胶囊只显示标题,发送那一刻才展开成完整引用文本,模型拿到的内容与以前一致;全文划词摘录、单条标注、单条笔记仍按纯文本插入。所有方式都只写进会话草稿(不自动发送、不抢焦点),文本携带 `itemKey` / `collectionKey` / 标签名供模型接续操作。标签类引用始终按全库范围展开,不受你当时选中哪个分类影响。
92
93
  - **胶囊依赖本插件展开**:草稿里留着引用胶囊时禁用或卸载本插件,发送会失败并提示找不到引用来源,把胶囊删掉即可继续正常发送。
93
- - **面板严格只读**:不提供任何新建 / 改名 / 删除分类的按钮。
94
+ - **分类只读**:不提供任何新建 / 改名 / 删除分类的按钮——整理分类是模型的活,人在面板里只管浏览与引用。
95
+ - **标注与笔记可写(默认关)**:配置卡打开「Zotero 写权限」并授权后,阅读页划选即写高亮 / 下划线(Zotero 色板七色 + 评论一次点明),点页内高亮弹出的标注卡片可当场「添加评论 / 改评论」,「标注」块还支持改色、改页码、加标签、高亮↔划线、删除,「笔记」块支持新建 / 编辑 / 删除。所有写入都直接进 Zotero 本地库,插件不存副本;含 Zotero 引文或标注锚点的笔记只给删除、不给编辑,改正文会让锚点失联。删除是**硬删**,不进 Zotero 回收站,面板里要点两次才会真删。开关关着时上述入口一个都不出现。
94
96
  - **模型侧工具可逐个开关**:插件自持连接集成 MCP,把工具以 `mcp__zotero__*` 注册进 dsh,可在插件页按工具启用 / 禁用。
95
97
 
96
98
  ## 插件页配置项
@@ -131,8 +133,8 @@ MCP 组下方是 **「MCP 工具」** 区:现场列出集成 MCP 的全部工
131
133
 
132
134
  | 半边 | 能力 | 通道 |
133
135
  |---|---|---|
134
- | **人侧面板** | 在 DSH 右侧栏只读浏览 Zotero 文库(分类树 / 标签面板 / 条目列表 / 搜索 / 条目详情 / 笔记 / 标注 / PDF 阅读),把条目(含多选批量)、摘录、标注、笔记、标签或整目录引用写进会话草稿 | 插件在宿主 web server 自注册的 `/dsh-zotero/api/*` 路由 |
135
- | **模型侧** | 检索、精读、按需操作文库 | 插件**自持**连接本机 Zotero 集成 MCP,工具以 `mcp__zotero__*` 注册给模型 |
136
+ | **人侧面板** | 在 DSH 右侧栏浏览 Zotero 文库(分类树 / 标签面板 / 条目列表 / 搜索 / 条目详情 / 笔记 / 标注 / PDF 阅读),把条目(含多选批量)、摘录、标注、笔记、标签或整目录引用写进会话草稿;开启写权限后还能就地新建 / 修改 / 删除高亮、划线与笔记 | 插件在宿主 web server 自注册的 `/dsh-zotero/api/*` 路由(写 action 另需自定义写头) |
137
+ | **模型侧** | 检索、精读、按需操作文库;条目 / 分类 / 标签 / 标识符的写走集成 MCP,标注与笔记的写走插件自带的 `zotero_*` 工具 | 插件**自持**连接本机 Zotero 集成 MCP,工具以 `mcp__zotero__*` 注册给模型 |
136
138
 
137
139
  MCP 没起,面板照常可用;Zotero 没开,模型工具自然也不可用。
138
140
 
@@ -140,7 +142,7 @@ MCP 没起,面板照常可用;Zotero 没开,模型工具自然也不可用
140
142
 
141
143
  | 半边 | 代码位置 | 通道 |
142
144
  |---|---|---|
143
- | Host | `src/index.ts`、`src/host/`、`src/zotero/` | 把 Zotero 本地 API 包装成只读 HTTP 端点,挂在 DSH 宿主 web server 上 |
145
+ | Host | `src/index.ts`、`src/host/`、`src/zotero/` | 把 Zotero 本地 API 包装成 HTTP 端点(读 + 受开关约束的写),挂在 DSH 宿主 web server 上 |
144
146
  | Client | `src/client/` | 在右侧栏注册 tab、面板正文与插件页配置卡,数据与选择状态放在模块级单例 |
145
147
 
146
148
  两条数据流:
@@ -161,12 +163,18 @@ MCP 没起,面板照常可用;Zotero 没开,模型工具自然也不可用
161
163
 
162
164
  ```
163
165
  src/ # 插件源码(主包,ESM / NodeNext / strict)
164
- ├── index.ts # Host 半入口:Config schema、HTTP 路由、MCP 桥接装配
166
+ ├── index.ts # Host 半入口:Config schema、HTTP 路由、MCP 桥接与写工具注册
165
167
  ├── host/
166
- │ ├── router.ts # 只读 HTTP 路由 GET /dsh-zotero/api/<action>
167
- │ └── mcp-bridge.ts # 自持集成 MCP 连接 + 按开关过滤注册模型工具
168
+ │ ├── router.ts # HTTP 路由 /dsh-zotero/api/<action>,含回环 + 写头栅栏
169
+ │ ├── mcp-bridge.ts # 自持集成 MCP 连接 + 按开关过滤注册模型工具
170
+ │ ├── write-tools.ts # 模型侧标注 / 笔记写工具(writeEnabled 关时不注册)
171
+ │ └── static.ts # PDF.js worker 等静态资源
168
172
  ├── zotero/
169
- │ ├── client.ts # Zotero 本地 API 客户端(只读)+ 笔记提取清洗 + 集成 MCP JSON-RPC
173
+ │ ├── client.ts # Zotero 本地 API 读取 + 笔记提取清洗 + 集成 MCP JSON-RPC
174
+ │ ├── write.ts # 本地 API 写通道:授权复用、版本前置条件
175
+ │ ├── key-store.ts # 写权限凭证落盘(0600)+ 从 Zotero 密钥库导入「始终允许」
176
+ │ ├── annotation-writes.ts / notes.ts # 标注与笔记的增改删语义校验
177
+ │ ├── palette.ts # 从真实库里枚举出的 Zotero 标注色板
170
178
  │ ├── config.ts # 端点 / 超时 / 截断阈值 + 运行时设置读取器
171
179
  │ └── types.ts # Host ↔ Client 数据契约
172
180
  └── client/ # Client 半(浏览器)
@@ -179,6 +187,7 @@ src/ # 插件源码(主包,ESM / NodeNext / strict)
179
187
  ├── ZoteroItemPane.tsx # 条目详情 tab 的正文与标题
180
188
  ├── ItemDetail.tsx # 文档优先详情:选附件 / 跨附件定位 / 打开 Zotero
181
189
  ├── InfoPanel.tsx # 左上角悬浮信息面板(可分块折叠)
190
+ ├── OutlinePanel.tsx # 左上角目录浮层(PDF 书签,点条目跳页)
182
191
  ├── viewer/ # 渲染器注册表 + PDF.js 渲染 / 文本回退 / 标注叠加与几何换算
183
192
  ├── AnnotationList.tsx / NoteList.tsx # 标注与笔记列表
184
193
  ├── Toast.tsx # 插入结果等轻提示
@@ -254,9 +263,19 @@ dsh --profile demo # 启动
254
263
 
255
264
  ⚠️ 前提是 [Zotero 里已装好集成 MCP 插件](#1-安装-zotero-mcp-插件)(或改用其他 MCP 插件并在配置卡填对 `mcpUrl`),并且开启了「允许写操作」。插件未安装或服务未起时,模型侧工具全部不可用;插件装了但没开写操作时,读类工具正常,`create_collection` 等写工具会被插件拒绝(返回「写操作已禁用」),表现为让模型帮忙新建分类直接报错——此时到 MCP 插件设置里打开写操作并重试即可,无需重启 dsh。
256
265
 
257
- ⚠️ 面板只读,**但模型侧工具不是**:25 个工具中含 10 个写工具(`write_item` / `write_note` / `write_tag` / `write_metadata` / `add_by_identifier` / `create_collection` / `update_collection` / `delete_collection` / `add_items_to_collection` / `remove_items_from_collection`)。想收紧为纯只读,直接在插件页配置卡的「MCP 工具」里关掉它们并保存即可;面板功能不受影响。
266
+ ⚠️ 模型的写能力有两处来源,都要单独关才收得住:集成 MCP 的 25 个工具里有 10 个写工具(`write_item` / `write_note` / `write_tag` / `write_metadata` / `add_by_identifier` / `create_collection` / `update_collection` / `delete_collection` / `add_items_to_collection` / `remove_items_from_collection`),可在配置卡的「MCP 工具」里逐个关掉;标注与笔记的写是插件自有的 `zotero_update_annotation` / `zotero_delete_annotation` / `zotero_create_note` / `zotero_update_note` / `zotero_delete_note` 五个工具,它们只在「Zotero 写权限」开关打开时才注册,关掉即从模型的工具表里消失。面板侧的分类操作始终只读。
258
267
 
259
- **写操作为什么优先走 MCP**:这些工具在 Zotero 进程内直接改库,不经过本地 API,因此**不会触发 Zotero 的「本地 API 授权」弹窗**。反过来,若让模型用 shell/curl 直接打 `127.0.0.1:23119` 的写接口,就必须先用 `POST /api/local/authorize` 换 key —— 该端点每次调用都会弹一次授权框,用户点「允许」拿到的 key 还是一次性的(首个写请求即被 Zotero 删除),这就是「每写一次就要点一次允许」的根源。为此插件在 [mcp-bridge.ts](src/host/mcp-bridge.ts) 里给所有写工具的描述统一注入了「首选写通道」引导语;「导入本地文件并挂到某条目下」用 `write_item` 的 `action: "import"` + `filePath` + `parentItemKey`,一条工具调用即可。
268
+ **写操作为什么优先走 MCP**:这些工具在 Zotero 进程内直接改库,不经过本地 API,因此**不会触发 Zotero 的「本地 API 授权」弹窗**。反过来,若让模型用 shell/curl 直接打 `127.0.0.1:23119` 的写接口,就必须先用 `POST /api/local/authorize` 换 key —— 该端点每次调用都会弹一次授权框,用户点「允许」拿到的 key 还是一次性的(首个写请求即被 Zotero 删除),这就是「每写一次就要点一次允许」的根源。为此插件在 [mcp-bridge.ts](src/host/mcp-bridge.ts) 里给所有写工具的描述统一注入了「首选写通道」引导语,并点明标注 / 笔记这两类 MCP 做不到、只能走插件自带的 `zotero_*` 工具;「导入本地文件并挂到某条目下」用 `write_item` 的 `action: "import"` + `filePath` + `parentItemKey`,一条工具调用即可。
269
+
270
+ ### 写权限与授权
271
+
272
+ 写能力默认全关,开启路径是「插件」页配置卡 → 「Zotero 写权限」:
273
+
274
+ 1. 打开「允许在 DSH 里修改 Zotero 文库」并保存 —— 面板的写入口与模型侧的 `zotero_*` 工具同时出现。
275
+ 2. 点「授权 Zotero 写权限」,Zotero 会弹一次「本地 API 授权」框,**请选「始终允许」**。选「允许」拿到的 key 是一次性的,第二条写就断。
276
+ 3. 「始终允许」的长期 key 会存到本机 `~/.dsh/storages/dsh-plugin-zotero/local-api-key.json`(`0600`,只在 Host 进程内读写,不进配置存储、不在表单里回显),之后**重启 dsh / 重启 Zotero 都直接复用,不用再点授权**。升级到带本功能的新版本时,会自动从 Zotero 自己的密钥库(profile 下的 `localAPIKeys.json`)导入此前点过的「始终允许」,同样不需要再点一次。撤销授权在 Zotero 侧做即可:下一次写入收到 401,插件随即删掉本地副本并回到「未授权」。
277
+
278
+ 写请求一律带并发前置条件(条目版本),撞上并发改动返回「Zotero 里这条已经变了」而不是覆盖;删除类操作在面板里必须点两次(「删除」→「确认删除」)才会真删,且是硬删、不进回收站。含 Zotero 引文 / 标注锚点的笔记不能编辑,只能删除。出问题时的止血手段仍是那个开关:关掉即彻底回到严格只读。
260
279
 
261
280
  ## 相关文档
262
281