@luffysolution/omnischolar-pi 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.
Files changed (7) hide show
  1. package/README.en.md +129 -0
  2. package/README.md +77 -120
  3. package/README.zh-CN.md +5 -1
  4. package/docs/INSTALLATION.en.md +9 -0
  5. package/docs/INSTALLATION.md +29 -0
  6. package/package.json +2 -1
  7. package/pi-extension/dist/index.js +1 -1
package/README.en.md ADDED
@@ -0,0 +1,129 @@
1
+ # OmniScholar
2
+
3
+ <!-- mcp-name: io.github.luffysolution-svg/omnischolar -->
4
+
5
+ [中文](README.md) | English
6
+
7
+ OmniScholar adds literature search, local Zotero reading, PDF parsing, citation tools, materials data, and scientific image generation to coding agents through a local Python MCP server.
8
+
9
+ It can search public indexes, combine online records with your Zotero notes, send an approved PDF to MinerU, and publish Markdown into a regular folder or an Obsidian vault. Zotero access is read-only.
10
+
11
+ ## Features
12
+
13
+ - Search Semantic Scholar, OpenAlex, PubMed/PMC, arXiv, Crossref, Unpaywall, easyScholar, Google Scholar, and Google Patents
14
+ - Retrieve paper details, authors, citations, references, recommendations, snippets, datasets, and journal metrics
15
+ - Read Zotero collections, items, notes, annotations, attachments, indexed text, and local PDF paths without changing the library
16
+ - Parse selected PDFs with MinerU and keep text, formulas, tables, and figures together
17
+ - Find citation candidates, check bibliographic identity, and format accepted references
18
+ - Query Materials Project and export JSON, CSV, Markdown, or CIF
19
+ - Generate or edit scientific illustrations with configured image services
20
+ - Preserve local Markdown edits and place incoming conflict versions in `.conflicts/`
21
+
22
+ OmniScholar exposes 38 tools. See the [tool list](docs/TOOLS.en.md).
23
+
24
+ <details>
25
+ <summary>Install and connect an agent</summary>
26
+
27
+ Python 3.11 or newer is required:
28
+
29
+ ```sh
30
+ uv tool install luffysolution-omnischolar
31
+ # or
32
+ pipx install luffysolution-omnischolar
33
+ # or
34
+ python -m pip install luffysolution-omnischolar
35
+ ```
36
+
37
+ Check, update, or uninstall the Python command:
38
+
39
+ ```sh
40
+ omnischolar --version
41
+ omnischolar doctor --json
42
+ uv tool upgrade luffysolution-omnischolar
43
+ uv tool uninstall luffysolution-omnischolar
44
+ ```
45
+
46
+ Codex plugin:
47
+
48
+ ```sh
49
+ codex plugin marketplace add luffysolution-svg/omnischolar --ref main
50
+ codex plugin add omnischolar@omnischolar
51
+ codex plugin marketplace upgrade omnischolar
52
+ codex plugin remove omnischolar@omnischolar
53
+ ```
54
+
55
+ Claude Code plugin:
56
+
57
+ ```text
58
+ /plugin marketplace add luffysolution-svg/omnischolar
59
+ /plugin install omnischolar@omnischolar
60
+ ```
61
+
62
+ Pi package:
63
+
64
+ ```sh
65
+ pi install npm:@luffysolution/omnischolar-pi
66
+ pi update npm:@luffysolution/omnischolar-pi
67
+ pi remove npm:@luffysolution/omnischolar-pi
68
+ ```
69
+
70
+ The standalone Skills CLI is optional because the plugins bundle their Skills:
71
+
72
+ ```sh
73
+ npx skills add luffysolution-svg/omnischolar --skill '*' --agent codex --global --yes
74
+ npx skills update --global --yes
75
+ npx skills remove --skill '*' --agent codex --global --yes
76
+ ```
77
+
78
+ The plugin and host configurations start the latest PyPI MCP with:
79
+
80
+ ```sh
81
+ uvx --from luffysolution-omnischolar@latest omnischolar mcp
82
+ ```
83
+
84
+ </details>
85
+
86
+ ## Agent configuration prompt
87
+
88
+ Use this as a starting prompt for an agent:
89
+
90
+ ```text
91
+ You are my research assistant using OmniScholar. Search and cite reliable scholarly sources, verify DOI and bibliographic identity, and clearly distinguish evidence from inference. You may read Zotero but must never modify it. Ask before uploading any PDF or reference image to an external service or making a paid request. For PDF reading, use MinerU only after I approve the upload. Save approved literature notes and generated artifacts to the configured output directory, preserve local edits, and report the exact output paths. Treat generated scientific figures as illustrations, never as experimental evidence.
92
+ ```
93
+
94
+ ## Configuration and examples
95
+
96
+ On the first MCP start or installer run, OmniScholar creates a complete user-level `omnischolar.config.json` template. API keys can be entered directly as `apiKey`, or supplied through the named `apiKeyEnv` environment variable.
97
+
98
+ The root [`mcp.json`](mcp.json) is a reusable MCP stdio example. It intentionally contains no API keys: the MCP process reads the global [`omnischolar.config.example.json`](omnischolar.config.example.json), which can be created with `omnischolar config init`. The plugin copy is [`.mcp.json`](.mcp.json).
99
+
100
+ Configure the Obsidian output location, paper folders, Markdown files, and parsed image assets with `output.rootDirectory`, `output.literatureDirectory`, `output.folderNameTemplate`, `output.filenameTemplate`, `output.filenameSeparator`, and `output.assetFilenameTemplate`; see [literature and output configuration](docs/RESEARCH.en.md).
101
+
102
+ ## Try it
103
+
104
+ ```text
105
+ Find five recent reviews about solid-state battery interfaces. Deduplicate by DOI and show open-access copies.
106
+
107
+ Find this DOI in my Zotero library and summarize my notes and annotations without changing Zotero.
108
+
109
+ After I approve the upload, parse this PDF with MinerU and save a reading note in my Obsidian vault.
110
+
111
+ Query stable Li-Fe-P-O materials in Materials Project and export the selected records as CSV and CIF.
112
+
113
+ Create a labelled illustration of this mechanism. Treat it as a draft, not experimental data.
114
+ ```
115
+
116
+ ## Documentation
117
+
118
+ - [Installation and agent setup](docs/INSTALLATION.en.md)
119
+ - [Configuration and service credentials](docs/CONFIGURATION.en.md)
120
+ - [Literature, Zotero, MinerU, citations, and output](docs/RESEARCH.en.md)
121
+ - [Materials and chemistry](docs/MATERIALS.en.md)
122
+ - [Scientific image providers](docs/IMAGE_PROVIDERS.en.md)
123
+ - [Tool list](docs/TOOLS.en.md)
124
+
125
+ ## Support and license
126
+
127
+ OmniScholar is open source under the [MIT License](LICENSE). Open a [GitHub issue](https://github.com/luffysolution-svg/omnischolar/issues) or email `LuffySolution@gmail.com`. Remove keys, signed URLs, private paper content, and personal Zotero data before sending a report.
128
+
129
+ Third-party services and datasets keep their own terms and licenses. See [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md).
package/README.md CHANGED
@@ -2,86 +2,82 @@
2
2
 
3
3
  <!-- mcp-name: io.github.luffysolution-svg/omnischolar -->
4
4
 
5
- English | [简体中文](README.zh-CN.md)
5
+ [![PyPI](https://img.shields.io/pypi/v/luffysolution-omnischolar?logo=pypi&label=PyPI)](https://pypi.org/project/luffysolution-omnischolar/)
6
+ [![npm](https://img.shields.io/npm/v/%40luffysolution%2Fomnischolar-pi?logo=npm&label=npm)](https://www.npmjs.com/package/@luffysolution/omnischolar-pi)
7
+ [![npx Skills](https://img.shields.io/badge/npx%20Skills-supported-CB3837?logo=npm&logoColor=white)](https://www.npmjs.com/package/skills)
8
+ [![Release](https://img.shields.io/github/v/release/luffysolution-svg/omnischolar?logo=github)](https://github.com/luffysolution-svg/omnischolar/releases)
6
9
 
7
- OmniScholar adds literature search, local Zotero reading, PDF parsing, citation tools, materials data, and scientific image generation to coding agents through a local Python MCP server.
10
+ 简体中文 | [English](README.en.md)
8
11
 
9
- It can search public indexes, combine online records with your Zotero notes, send an approved PDF to MinerU, and publish Markdown into a regular folder or an Obsidian vault. Zotero access is read-only.
12
+ OmniScholar 通过本地 Python MCP 服务，为 Codex、Claude Code、Cursor、OpenCode、Hermes 和 Pi 提供文献检索、Zotero 读取、PDF 解析、引用处理、材料数据和科研绘图工具。
10
13
 
11
- ## Features
14
+ 它可以把在线文献记录与 Zotero 笔记放在一起处理，将经你确认的 PDF 交给 MinerU 解析，再把 Markdown 保存到普通文件夹或 Obsidian Vault。Zotero 全程只读。
12
15
 
13
- - Search Semantic Scholar, OpenAlex, PubMed/PMC, arXiv, Crossref, Unpaywall, easyScholar, Google Scholar, and Google Patents
14
- - Retrieve paper details, authors, citations, references, recommendations, snippets, datasets, and journal metrics
15
- - Read Zotero collections, items, notes, annotations, attachments, indexed text, and local PDF paths without changing the library
16
- - Parse selected PDFs with MinerU and keep text, formulas, tables, and figures together
17
- - Find citation candidates, check bibliographic identity, and format accepted references
18
- - Query Materials Project and export JSON, CSV, Markdown, or CIF
19
- - Generate or edit scientific illustrations with configured image services
20
- - Preserve local Markdown edits and place incoming conflict versions in `.conflicts/`
16
+ ## 功能
21
17
 
22
- OmniScholar exposes 38 tools. See the [tool list](docs/TOOLS.en.md).
18
+ - 检索 Semantic Scholar、OpenAlex、PubMed/PMC、arXiv、Crossref、Unpaywall、easyScholar、Google Scholar 和 Google Patents
19
+ - 查询论文详情、作者、参考文献、施引文献、推荐、全文片段、数据集和期刊指标
20
+ - 读取 Zotero 收藏夹、条目、笔记、批注、附件、索引文本和本地 PDF 路径，不修改文献库
21
+ - 使用 MinerU 提取指定 PDF 的正文、公式、表格和图片
22
+ - 查找引用候选，核对书目信息，再按要求生成参考文献
23
+ - 查询 Materials Project，并导出 JSON、CSV、Markdown 或 CIF
24
+ - 调用已配置的图片服务生成或编辑科研示意图
25
+ - 保留手工修改过的 Markdown，把待合并版本放入 `.conflicts/`
23
26
 
24
- ## Install
27
+ OmniScholar 共提供 38 个工具，完整列表见[工具目录](docs/TOOLS.md)。
25
28
 
26
- Python 3.11 or newer is required:
29
+ <details>
30
+ <summary>安装与部署</summary>
31
+
32
+ 需要 Python 3.11 或更高版本。普通 Python 命令任选一种方式安装：
27
33
 
28
34
  ```sh
29
35
  uv tool install luffysolution-omnischolar
30
- # or
36
+ # 或
31
37
  pipx install luffysolution-omnischolar
32
- # or
38
+ # 或
33
39
  python -m pip install luffysolution-omnischolar
34
40
  ```
35
41
 
36
- For development from a source checkout, replace the package name with `.`.
37
-
38
- The distribution name is `luffysolution-omnischolar`; the command and Python package are `omnischolar`.
39
-
40
- Check the installation:
42
+ 检查、更新和卸载：
41
43
 
42
44
  ```sh
43
45
  omnischolar --version
44
46
  omnischolar doctor --json
45
- ```
46
-
47
- Update or uninstall the Python command:
48
-
49
- ```sh
50
47
  uv tool upgrade luffysolution-omnischolar
51
48
  uv tool uninstall luffysolution-omnischolar
52
49
  ```
53
50
 
54
- ## Connect an agent
51
+ 如果希望用一条命令强制刷新并重装最新版：
55
52
 
56
- ### Codex app and Codex CLI plugin
53
+ ```sh
54
+ uv tool install --reinstall luffysolution-omnischolar
55
+ ```
57
56
 
58
- Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/) first, then add the OmniScholar Git marketplace and install the plugin:
57
+ ### Codex 插件
59
58
 
60
59
  ```sh
61
60
  codex plugin marketplace add luffysolution-svg/omnischolar --ref main
62
61
  codex plugin add omnischolar@omnischolar
62
+ codex plugin marketplace upgrade omnischolar
63
63
  ```
64
64
 
65
- In the ChatGPT desktop app, restart the app, open **Plugins**, select the **OmniScholar** marketplace, and install or enable **OmniScholar**. In Codex CLI, run `/plugins` to browse the same marketplace.
66
-
67
- The plugin bundles all eight Skills and starts its local MCP server from the latest PyPI release:
65
+ ChatGPT 桌面应用中重启应用后打开 **Plugins**，选择 **OmniScholar** 并安装或启用；Codex CLI 可运行 `/plugins` 浏览插件。插件已经包含 Skills，并通过下面的命令启动 PyPI 最新 MCP：
68
66
 
69
67
  ```sh
70
68
  uvx --from luffysolution-omnischolar@latest omnischolar mcp
71
69
  ```
72
70
 
73
- No separate `pip install` is required for this plugin path. `@latest` asks `uvx` to resolve the latest package instead of pinning this plugin to a release number. Provider credentials and optional service settings remain in your OmniScholar configuration; plugin installation does not collect them.
71
+ ### Claude Code 插件
74
72
 
75
- ### Claude Code plugin
76
-
77
- Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/) first. In Claude Code, add the GitHub marketplace and install the plugin:
73
+ 在 Claude Code 会话中运行：
78
74
 
79
75
  ```text
80
76
  /plugin marketplace add luffysolution-svg/omnischolar
81
77
  /plugin install omnischolar@omnischolar
82
78
  ```
83
79
 
84
- For scripts or a regular terminal, use the non-interactive shell commands:
80
+ 普通终端也可以运行：
85
81
 
86
82
  ```sh
87
83
  claude plugin marketplace add luffysolution-svg/omnischolar
@@ -89,26 +85,7 @@ claude plugin install omnischolar@omnischolar --scope user
89
85
  claude plugin update omnischolar@omnischolar --scope user
90
86
  ```
91
87
 
92
- Run `/reload-plugins` if the install summary asks for it, then start a new session. The plugin automatically starts the latest `uvx` MCP server and exposes namespaced Skills such as `/omnischolar:scholar-search`. No separate Python installation is required.
93
-
94
- ### Host configuration installer
95
-
96
- Preview the files that will change, then install the local MCP entry and Skills:
97
-
98
- ```sh
99
- omnischolar install --dry-run claude
100
- omnischolar install claude
101
- ```
102
-
103
- Replace `claude` with `codex`, `cursor`, `opencode`, `hermes`, `pi`, or `workbuddy`. Codex, Claude Code, Cursor, OpenCode, Pi, and WorkBuddy/CodeBuddy support both user and project scopes. Hermes supports user-level MCP configuration; project-level installation adds Skills and reports that MCP setup is manual.
104
-
105
- ```sh
106
- omnischolar install cursor --scope project
107
- omnischolar update cursor --scope project
108
- omnischolar uninstall cursor --scope project
109
- ```
110
-
111
- For Pi, the full installer runs `pi install npm:@luffysolution/omnischolar-pi` and installs the bundled Skills separately. The npm Extension starts the matching PyPI MCP through `uvx`, discovers its tools, and registers them with Pi; a separate global Python CLI installation is not required. You can also install the Extension directly:
88
+ ### Pi Extension
112
89
 
113
90
  ```sh
114
91
  pi install npm:@luffysolution/omnischolar-pi
@@ -116,100 +93,80 @@ pi update npm:@luffysolution/omnischolar-pi
116
93
  pi remove npm:@luffysolution/omnischolar-pi
117
94
  ```
118
95
 
119
- WorkBuddy/CodeBuddy uses `~/.codebuddy/.mcp.json` for user scope and `.mcp.json` for project scope. It does not publish a portable Skills path, so its installer configures MCP and reports Skills as `manual_required`.
120
-
121
- The direct latest MCP command is:
96
+ ### 通用安装器与独立 Skills
122
97
 
123
98
  ```sh
124
- uvx --from luffysolution-omnischolar@latest omnischolar mcp
99
+ omnischolar install --dry-run claude
100
+ omnischolar install claude
101
+ omnischolar update claude
102
+ omnischolar uninstall claude
125
103
  ```
126
104
 
127
- Normally the agent starts this process from its MCP configuration. The installer checks `initialize`, `tools/list`, and `omnischolar_status` after writing a supported configuration.
128
-
129
- Full host and update instructions are in [Installation](docs/INSTALLATION.en.md).
130
-
131
- ### Standalone Skills CLI
132
-
133
- Plugins already bundle their declared Skills. Use the official Skills CLI separately when you want to install the repository's Skills directly into an agent:
105
+ 也可以使用官方 Skills CLI 单独安装 Skills；插件已经包含这些 Skills，通常不需要重复安装：
134
106
 
135
107
  ```sh
136
- # User scope; replace codex with claude-code, pi, cursor, or another supported agent
137
108
  npx skills add luffysolution-svg/omnischolar --skill '*' --agent codex --global --yes
138
109
  npx skills update --global --yes
139
110
  npx skills remove --skill '*' --agent codex --global --yes
140
111
  ```
141
112
 
142
- ## Try it
113
+ 完整的各 Agent 路径、项目级安装和故障排查见[安装说明](docs/INSTALLATION.md)。
143
114
 
144
- ```text
145
- Find five recent reviews about solid-state battery interfaces. Deduplicate by DOI and show open-access copies.
115
+ </details>
146
116
 
147
- Find this DOI in my Zotero library and summarize my notes and annotations without changing Zotero.
117
+ ## Agent 配置提示词
148
118
 
149
- After I approve the upload, parse this PDF with MinerU and save a reading note in my Obsidian vault.
119
+ 可以将下面的提示词作为 Agent 的项目级指令或系统提示词基础：
150
120
 
151
- Query stable Li-Fe-P-O materials in Materials Project and export the selected records as CSV and CIF.
152
-
153
- Create a labelled illustration of this mechanism. Treat it as a draft, not experimental data.
121
+ ```text
122
+ 你是我的科研助理，使用 OmniScholar 完成文献检索、Zotero 阅读、PDF 解析、引用核对和科研资料整理。检索时优先使用可靠的学术来源，核对 DOI 与书目信息，并明确区分原文证据、推断和不确定内容。Zotero 只允许读取，禁止修改。上传 PDF、参考图或发起可能收费的请求前必须先征得我的确认；MinerU 只有在我确认后才能上传文件。将确认后的文献笔记和生成文件保存到配置的输出目录，保留已有手工修改，并报告最终文件路径。生成的科研图片只能作为示意图，不能当作实验数据或科研证据。
154
123
  ```
155
124
 
156
- ## Configuration
125
+ ## 配置与 MCP 示例
157
126
 
158
- On the first MCP start or installer run, if no discoverable config exists, OmniScholar creates a complete user-level `omnischolar.config.json` template with all service sections and credential fields. You can also create it explicitly with `omnischolar config init`. API keys may be entered directly as `apiKey`; `apiKeyEnv` is an optional alternative when you prefer environment variables.
127
+ 首次启动 MCP 或运行安装器时，如果没有可发现的配置，OmniScholar 会创建用户级 `omnischolar.config.json` 模板。API key 可以直接填写到 `apiKey`，也可以用 `apiKeyEnv` 指定环境变量。
159
128
 
160
- Customize the Obsidian output location, paper folders, Markdown files, and parsed image assets with `output.rootDirectory`, `output.literatureDirectory`, `output.folderNameTemplate`, `output.filenameTemplate`, `output.filenameSeparator`, and `output.assetFilenameTemplate`; see [literature and output configuration](docs/RESEARCH.en.md).
161
-
162
- A small local configuration can start with Zotero and the output directory:
129
+ 根目录的 [`mcp.json`](mcp.json) 是可直接复制到支持 MCP 的 Agent 中的 stdio 示例，内容如下：
163
130
 
164
131
  ```json
165
132
  {
166
- "schemaVersion": 1,
167
- "runtime": { "workspaceRoots": ["./research-inputs"] },
168
- "zotero": {
169
- "enabled": true,
170
- "baseUrl": "http://127.0.0.1:23119/api"
171
- },
172
- "output": { "rootDirectory": "./research-output" }
133
+ "mcpServers": {
134
+ "omnischolar": {
135
+ "type": "stdio",
136
+ "command": "uvx",
137
+ "args": ["--from", "luffysolution-omnischolar@latest", "omnischolar", "mcp"]
138
+ }
139
+ }
173
140
  }
174
141
  ```
175
142
 
176
- OpenAlex, PubMed, arXiv, and Crossref work without API keys. Other services are enabled separately. Configuration fields and provider examples are in [Configuration](docs/CONFIGURATION.en.md).
143
+ `mcp.json` 只负责启动 MCP，不保存 API key；服务凭据和 Obsidian 输出位置填写在 [`omnischolar.config.example.json`](omnischolar.config.example.json) 对应字段中，可执行 `omnischolar config init` 创建实际配置。插件内部使用的配置文件是 [`.mcp.json`](.mcp.json)。文件夹、Markdown 文件和图片附件命名可通过 `output` 区块自定义，详见[文献与输出配置](docs/RESEARCH.md)。
144
+
145
+ ## 使用示例
177
146
 
178
- ## Files, uploads, and charges
147
+ ```text
148
+ 查找 5 篇关于固态电池界面的近期综述，按 DOI 去重，并给出开放获取版本。
179
149
 
180
- - Zotero requests go only to the local API on port `23119` and use GET.
181
- - MinerU receives a PDF only when `allowExternalUpload` is enabled in the config and confirmed again in that tool call.
182
- - Image services receive prompts and any reference images selected for upload. Generation may use account credit.
183
- - Ai4Scholar calls may use account credit. A stored key does not by itself approve a paid call.
184
- - A failed paid request is not retried automatically when the provider may already have accepted it.
185
- - Generated images are illustrations. They are not measurements, experimental evidence, or scientific results.
150
+ 在我的 Zotero 中找到这个 DOI，汇总笔记和批注，不要修改 Zotero。
186
151
 
187
- See [`PRIVACY.md`](PRIVACY.md) and [Configuration](docs/CONFIGURATION.en.md) before enabling uploads or paid services.
152
+ 我确认上传后，用 MinerU 解析这份 PDF，并把阅读笔记保存到 Obsidian Vault。
188
153
 
189
- ## Included Skills
154
+ 查询 Materials Project 中稳定的 Li-Fe-P-O 材料，将选中的记录导出为 CSV 和 CIF。
190
155
 
191
- | Skill | Use |
192
- |---|---|
193
- | `omnischolar` | Choose and combine tools for a research request |
194
- | `scholar-search` | Literature, patents, authors, citation graphs, journals, and datasets |
195
- | `zotero-research` | Local Zotero matching, notes, annotations, and attachments |
196
- | `paper-reading` | MinerU parsing and close reading of text, formulas, tables, and figures |
197
- | `academic-citation` | Evidence checks, citation candidates, formatting, and bibliographies |
198
- | `scientific-figure` | Image generation, editing, review, and scientific labelling |
199
- | `materials-project` | Materials screening, properties, provenance, phase data, and export |
200
- | `chemical-data` | CAS Common Chemistry records when an official interface description is configured |
156
+ 为这个机理绘制带标签的示意图。图片只是草稿，不得写成实验数据。
157
+ ```
201
158
 
202
- ## Documentation
159
+ ## 文档
203
160
 
204
- - [Installation and agent setup](docs/INSTALLATION.en.md)
205
- - [Configuration and service credentials](docs/CONFIGURATION.en.md)
206
- - [Literature, Zotero, MinerU, citations, and output](docs/RESEARCH.en.md)
207
- - [Materials and chemistry](docs/MATERIALS.en.md)
208
- - [Scientific image providers](docs/IMAGE_PROVIDERS.en.md)
209
- - [Tool list](docs/TOOLS.en.md)
161
+ - [安装与 Agent 配置](docs/INSTALLATION.md)
162
+ - [配置与服务凭据](docs/CONFIGURATION.md)
163
+ - [文献、Zotero、MinerU、引用与输出](docs/RESEARCH.md)
164
+ - [材料与化学](docs/MATERIALS.md)
165
+ - [科研绘图服务](docs/IMAGE_PROVIDERS.md)
166
+ - [工具目录](docs/TOOLS.md)
210
167
 
211
- ## Support and license
168
+ ## 支持与许可证
212
169
 
213
- OmniScholar is open source under the [MIT License](LICENSE). Open a [GitHub issue](https://github.com/luffysolution-svg/omnischolar/issues) or email `LuffySolution@gmail.com`. Remove keys, signed URLs, private paper content, and personal Zotero data before sending a report.
170
+ OmniScholar 使用 [MIT License](LICENSE) 开源。可以在 [GitHub Issues](https://github.com/luffysolution-svg/omnischolar/issues) 提交问题，或发送邮件到 `LuffySolution@gmail.com`。报告问题前，请删除 API key、签名 URL、私人论文内容和个人 Zotero 数据。
214
171
 
215
- Third-party services and datasets keep their own terms and licenses. See [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md).
172
+ 第三方服务和数据遵循各自的条款与许可证，详见 [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md)。
package/README.zh-CN.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # OmniScholar
2
2
 
3
- [English](README.md) | 简体中文
3
+ [English](README.en.md) | 简体中文
4
4
 
5
5
  OmniScholar 通过本地 Python MCP 服务，为 Codex、Claude Code、Cursor、OpenCode、Hermes 和 Pi 等 Agent 提供文献检索、Zotero 读取、PDF 解析、引用处理、材料数据和科研绘图工具。
6
6
 
@@ -47,6 +47,10 @@ omnischolar doctor --json
47
47
  ```sh
48
48
  uv tool upgrade luffysolution-omnischolar
49
49
  uv tool uninstall luffysolution-omnischolar
50
+ pipx upgrade luffysolution-omnischolar
51
+ pipx uninstall luffysolution-omnischolar
52
+ python -m pip install --upgrade luffysolution-omnischolar
53
+ python -m pip uninstall luffysolution-omnischolar
50
54
  ```
51
55
 
52
56
  ## 连接 Agent
package/docs/INSTALLATION.en.md CHANGED
@@ -19,6 +19,15 @@ uv tool upgrade luffysolution-omnischolar
19
19
  uv tool uninstall luffysolution-omnischolar
20
20
  ```
21
21
 
22
+ If you originally installed with `pipx` or `pip`, use the matching update and uninstall commands:
23
+
24
+ ```sh
25
+ pipx upgrade luffysolution-omnischolar
26
+ pipx uninstall luffysolution-omnischolar
27
+ python -m pip install --upgrade luffysolution-omnischolar
28
+ python -m pip uninstall luffysolution-omnischolar
29
+ ```
30
+
22
31
  For development from a source checkout, replace the package name with `.`.
23
32
 
24
33
  Check the command:
package/docs/INSTALLATION.md CHANGED
@@ -12,6 +12,18 @@ pipx install luffysolution-omnischolar
12
12
  python -m pip install luffysolution-omnischolar
13
13
  ```
14
14
 
15
+ 如果该工具已经安装，`uv tool install` 会保持现有版本，不会自动升级。要获取 PyPI 最新版本，请使用：
16
+
17
+ ```sh
18
+ uv tool upgrade luffysolution-omnischolar
19
+ ```
20
+
21
+ 需要强制刷新并重新安装时使用：
22
+
23
+ ```sh
24
+ uv tool install --reinstall luffysolution-omnischolar
25
+ ```
26
+
15
27
  更新或卸载 Python 命令：
16
28
 
17
29
  ```sh
@@ -19,6 +31,15 @@ uv tool upgrade luffysolution-omnischolar
19
31
  uv tool uninstall luffysolution-omnischolar
20
32
  ```
21
33
 
34
+ 若最初使用 `pipx` 或 `pip`，对应的更新和卸载命令是：
35
+
36
+ ```sh
37
+ pipx upgrade luffysolution-omnischolar
38
+ pipx uninstall luffysolution-omnischolar
39
+ python -m pip install --upgrade luffysolution-omnischolar
40
+ python -m pip uninstall luffysolution-omnischolar
41
+ ```
42
+
22
43
  如需从源码开发安装，请将包名替换为 `.`。
23
44
 
24
45
  验证命令是否可用：
@@ -196,6 +217,14 @@ npx skills remove --skill '*' -a codex -y
196
217
 
197
218
  这组命令只安装 Skills，不会安装 `omnischolar` Python 命令。通过 Codex/Claude plugin 或 Pi Extension 安装时，插件/安装器已经处理了对应 Skills，不需要重复执行。
198
219
 
220
+ ## Agent 配置提示词
221
+
222
+ 可以将下面的提示词作为 Agent 的项目级指令或系统提示词基础：
223
+
224
+ ```text
225
+ 你是我的科研助理，使用 OmniScholar 完成文献检索、Zotero 阅读、PDF 解析、引用核对和科研资料整理。检索时优先使用可靠的学术来源，核对 DOI 与书目信息，并明确区分原文证据、推断和不确定内容。Zotero 只允许读取，禁止修改。上传 PDF、参考图或发起可能收费的请求前必须先征得我的确认；MinerU 只有在我确认后才能上传文件。将确认后的文献笔记和生成文件保存到配置的输出目录，保留已有手工修改，并报告最终文件路径。生成的科研图片只能作为示意图，不能当作实验数据或科研证据。
226
+ ```
227
+
199
228
  ## MCP 连接失败
200
229
 
201
230
  1. 运行 `omnischolar --version`，确认 Agent 的 PATH 能找到该命令。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@luffysolution/omnischolar-pi",
3
- "version": "0.1.11",
3
+ "version": "0.1.13",
4
4
  "description": "Pi MCP bridge for the OmniScholar research toolkit",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -29,6 +29,7 @@
29
29
  "files": [
30
30
  "pi-extension/dist",
31
31
  "README.md",
32
+ "README.en.md",
32
33
  "README.zh-CN.md",
33
34
  "LICENSE",
34
35
  "PRIVACY.md",
package/pi-extension/dist/index.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import { Client } from "@modelcontextprotocol/sdk/client/index.js";
2
2
  import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";
3
3
  import { Type } from "typebox";
4
- const CLIENT_INFO = { name: "omnischolar-pi", version: "0.1.11" };
4
+ const CLIENT_INFO = { name: "omnischolar-pi", version: "0.1.13" };
5
5
  export function resultText(result) {
6
6
  return result.content
7
7
  .map((item) => {