@llangtop/pwiki-mcp 1.0.7 → 1.1.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.
Files changed (2) hide show
  1. package/README.md +65 -112
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,81 +1,14 @@
1
- # Pwiki
1
+ # @llangtop/pwiki-mcp
2
2
 
3
- > 本地知识库 CLI — 关键词 + 语义 + 混合搜索，ONNX 本地模型，零云依赖。
3
+ Wiki 知识库 MCP Server，接入 Claude Code / Cursor 等 AI 客户端。
4
4
 
5
- ## 快速开始
5
+ ## 安装
6
6
 
7
7
  ```bash
8
- # ① 安装
9
- npm i -g @llangtop/pwiki-cli
8
+ npm i -g @llangtop/pwiki-mcp
10
9
  ```
11
10
 
12
- ```bash
13
- # ② 下载模型 + 启用语义（~130MB，只需一次）
14
- pwiki setup
15
- ```
16
-
17
- ```bash
18
- # ③ 加载目录
19
- pwiki load D:\my-notes
20
- ```
21
-
22
- ```bash
23
- # ④ 生成 embedding（首次加载后需要，之后新增文件自动索引）
24
- pwiki refresh
25
- ```
26
-
27
- ```bash
28
- # ⑤ 搜索
29
- pwiki search "关键词" # 关键词，立即可用
30
- pwiki search "描述" --hybrid # 混合（推荐），refresh 后才有效
31
- pwiki search "描述" -s # 纯语义，同上
32
- ```
33
-
34
- > **注意**：关键词搜索 `load` 后立即可用。语义和混合搜索需要 `refresh` 生成 embedding 向量。
35
-
36
- ## 常用命令
37
-
38
- ```bash
39
- # ---- 搜索 ----
40
- pwiki search "关键词" # 关键词（最快）
41
- pwiki search "xxx" --hybrid # 混合（推荐）
42
- pwiki search "xxx" -s # 语义
43
- pwiki search "xxx" -f # 显示全文
44
-
45
- # ---- 管理 ----
46
- pwiki load <目录> # 加载数据源
47
- pwiki unload # 查看已加载
48
- pwiki refresh # 重建索引 + embedding
49
- pwiki status # 状态概览
50
-
51
- # ---- 条目 ----
52
- pwiki read <相对路径> # 读全文
53
- pwiki create <源> <文件>.md -t "标题" --tags "a,b" --content "正文"
54
-
55
- # ---- 语义 ----
56
- pwiki models # 可用模型列表
57
- pwiki model-download -m bge-m3 # 换模型
58
- pwiki semantic on / off # 开关
59
- pwiki embed # 单独重建 embedding
60
-
61
- # ---- 编译（需 API Key）----
62
- $env:DEEPSEEK_API_KEY="sk-xxx"
63
- pwiki compile-status # 查看未编译
64
- pwiki compile --all # 批量编译
65
- ```
66
-
67
- ## 环境变量
68
-
69
- | 变量 | 用途 | 默认 |
70
- |------|------|------|
71
- | `WIKI_HOME` | 数据目录 | `~/.pwiki` |
72
- | `WIKI_MODEL_ID` | 嵌入模型 | `bge-base-zh-v1.5` |
73
- | `DEEPSEEK_API_KEY` | LLM 编译 API | — |
74
- | `OPENAI_API_KEY` | LLM 编译 API（备选） | — |
75
-
76
- ## MCP 接入
77
-
78
- ### 配置
11
+ ## 配置
79
12
 
80
13
  ```json
81
14
  {
@@ -85,53 +18,73 @@ pwiki compile --all # 批量编译
85
18
  "args": ["%APPDATA%\\npm\\node_modules\\@llangtop\\pwiki-mcp\\dist\\index.js"],
86
19
  "env": {
87
20
  "WIKI_HOME": "C:\\Users\\xxx\\.pwiki",
88
- "DEEPSEEK_API_KEY": "sk-xxx"
21
+ "LLM_API_KEY": "sk-xxx"
89
22
  }
90
23
  }
91
24
  }
92
25
  }
93
26
  ```
94
27
 
95
- ### 前置条件
28
+ ## 工具（19 个）
96
29
 
97
- MCP 连接前，先确保数据已就绪：
30
+ ### 搜索与读取
98
31
 
99
- ```bash
100
- pwiki setup # 下载模型 + 启用语义
101
- pwiki load <目录> # 加载数据源
102
- pwiki refresh # 生成 embedding（语义搜索必需）
103
- ```
32
+ | 工具 | 说明 |
33
+ |------|------|
34
+ | `wiki_search` | 搜索，默认 hybrid |
35
+ | `wiki_read_entry` | 读条目全文 |
104
36
 
105
- ### 工具清单（19 个）
106
-
107
- | 工具 | 用途 | 典型用法 |
108
- |------|------|------|
109
- | `wiki_search` | 搜索（默认 hybrid） | "部署流程怎么走" |
110
- | `wiki_read_entry` | 读条目全文 | 从搜索结果中取 `relPath` 读取 |
111
- | `wiki_status` | 查看 wiki 状态 | 确认数据源、向量数、质心 |
112
- | `wiki_load` | 加载数据源 | 新目录加入知识库 |
113
- | `wiki_unload` | 卸载 / 列出数据源 | 无参列出所有已加载 |
114
- | `wiki_refresh` | 重建索引+embedding | 源文件变更后同步 |
115
- | `wiki_create_entry` | 创建 .md 条目 | 记笔记 |
116
- | `wiki_modify_entry` | 覆盖修改条目 | 改内容 |
117
- | `wiki_rename_entry` | 重命名标题 | 改 frontmatter title |
118
- | `wiki_move_entry` | 移动文件 | 整理目录结构 |
119
- | `wiki_enable_semantic` | 开关语义搜索 | 切换模型 |
120
- | `wiki_generate_embeddings` | 重建向量 | 批量生成 embedding |
121
- | `wiki_list_models` | 列出嵌入模型 | 返回 JSON：id/dim/languages |
122
- | `wiki_compile_status` | 编译状态 | 看哪些文件未编译 |
123
- | `wiki_compile` | 编译单个文件 | 提升搜索质量 |
124
- | `wiki_compile_all` | 批量编译 | `limit` 控制篇数 |
125
- | `wiki_get_compile_prompt` | 获取编译 prompt | 自定义 LLM 编译流程 |
126
- | `wiki_store_compiled` | 存入编译结果 | 配合 `wiki_get_compile_prompt` |
127
- | `wiki_llm_status` | LLM 配置状态 | 检查 API Key |
128
-
129
- ### 典型工作流
37
+ ### 数据源
130
38
 
131
- ```
132
- 用户: "西部管网有哪些费用类型"
133
- → wiki_search(query="西部管网 费用类型")
134
- → 返回 5 条，选出最相关的 relPath
135
- → wiki_read_entry(path="工作/西部网管/示数分析.md")
136
- → 返回完整内容，回答问题
137
- ```
39
+ | 工具 | 说明 |
40
+ |------|------|
41
+ | `wiki_load` | 加载目录 |
42
+ | `wiki_unload` | 卸载 / 列出 |
43
+ | `wiki_refresh` | 重建索引 + embedding |
44
+
45
+ ### 条目管理
46
+
47
+ | 工具 | 说明 |
48
+ |------|------|
49
+ | `wiki_create_entry` | 创建 .md 条目 |
50
+ | `wiki_modify_entry` | 覆盖修改 |
51
+ | `wiki_rename_entry` | 重命名 |
52
+ | `wiki_move_entry` | 移动 |
53
+
54
+ ### 语义
55
+
56
+ | 工具 | 说明 |
57
+ |------|------|
58
+ | `wiki_enable_semantic` | 开关语义搜索 |
59
+ | `wiki_generate_embeddings` | 生成向量 |
60
+ | `wiki_list_models` | 模型列表（JSON） |
61
+
62
+ ### 编译（需 API Key）
63
+
64
+ | 工具 | 说明 |
65
+ |------|------|
66
+ | `wiki_compile_status` | 编译状态 |
67
+ | `wiki_compile` | 编译单个 |
68
+ | `wiki_compile_all` | 批量编译 |
69
+ | `wiki_get_compile_prompt` | 获取编译 prompt |
70
+ | `wiki_store_compiled` | 存入编译结果 |
71
+
72
+ ### 状态
73
+
74
+ | 工具 | 说明 |
75
+ |------|------|
76
+ | `wiki_status` | 总览（建议 first call） |
77
+ | `wiki_llm_status` | LLM 配置 |
78
+
79
+ ## 前置条件
80
+
81
+ AI 连接 MCP 后，`wiki_status` 会引导完成：加载 → 语义 → embedding。
82
+
83
+ ## 环境变量
84
+
85
+ | 变量 | 用途 |
86
+ |------|------|
87
+ | `WIKI_HOME` | 数据目录 |
88
+ | `LLM_API_KEY` | LLM API Key |
89
+ | `LLM_API_BASE` | 自定义 API 地址 |
90
+ | `LLM_MODEL` | 自定义模型 |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@llangtop/pwiki-mcp",
3
- "version": "1.0.7",
3
+ "version": "1.1.0",
4
4
  "description": "Wiki knowledge base MCP server — for Claude Code, Cursor, and other MCP clients",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",