@llangtop/pwiki-mcp 1.0.6 → 1.0.8
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 +90 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# @llangtop/pwiki-mcp
|
|
2
|
+
|
|
3
|
+
Wiki 知识库 MCP Server，接入 Claude Code / Cursor 等 AI 客户端。
|
|
4
|
+
|
|
5
|
+
## 安装
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm i -g @llangtop/pwiki-mcp
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## 配置
|
|
12
|
+
|
|
13
|
+
```json
|
|
14
|
+
{
|
|
15
|
+
"mcpServers": {
|
|
16
|
+
"pwiki": {
|
|
17
|
+
"command": "node",
|
|
18
|
+
"args": ["%APPDATA%\\npm\\node_modules\\@llangtop\\pwiki-mcp\\dist\\index.js"],
|
|
19
|
+
"env": {
|
|
20
|
+
"WIKI_HOME": "C:\\Users\\xxx\\.pwiki",
|
|
21
|
+
"LLM_API_KEY": "sk-xxx"
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## 工具（19 个）
|
|
29
|
+
|
|
30
|
+
### 搜索与读取
|
|
31
|
+
|
|
32
|
+
| 工具 | 说明 |
|
|
33
|
+
|------|------|
|
|
34
|
+
| `wiki_search` | 搜索，默认 hybrid |
|
|
35
|
+
| `wiki_read_entry` | 读条目全文 |
|
|
36
|
+
|
|
37
|
+
### 数据源
|
|
38
|
+
|
|
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,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@llangtop/pwiki-mcp",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.8",
|
|
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",
|
|
7
7
|
"bin": {
|
|
8
8
|
"pwiki-mcp": "./dist/index.js"
|
|
9
9
|
},
|
|
10
|
-
"files": ["dist"],
|
|
10
|
+
"files": ["dist", "README.md"],
|
|
11
11
|
"scripts": {
|
|
12
12
|
"build": "tsc",
|
|
13
13
|
"start": "node dist/index.js"
|