wenlan-mcp 0.19.3 → 0.20.1
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 +46 -26
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -29,9 +29,9 @@
|
|
|
29
29
|
|
|
30
30
|
<!-- R113 walkthrough: approved 0.5-second cover; 1080p; original video/audio and masters retained. -->
|
|
31
31
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
32
|
+
<p align="center">
|
|
33
|
+
<a href="https://github.com/user-attachments/assets/5e661389-d7ea-4a36-a645-2b1ec2a92d32"><img src="./docs/assets/readme-video-cover-en.png" alt="Watch the Wenlan walkthrough" width="100%"></a>
|
|
34
|
+
</p>
|
|
35
35
|
|
|
36
36
|
<a id="why-wenlan"></a>
|
|
37
37
|
|
|
@@ -41,7 +41,7 @@ https://github.com/user-attachments/assets/5e661389-d7ea-4a36-a645-2b1ec2a92d32
|
|
|
41
41
|
|
|
42
42
|
I started Wenlan out of anxiety about my own knowledge: notes, documents, and AI chats scattered everywhere, always changing. Keeping an Obsidian vault from rotting within three months took plugins, a workflow, and constant upkeep, and LLM-wiki setups weren't much easier day to day. I wanted an AI-native knowledge base app that stays useful without the hassle.
|
|
43
43
|
|
|
44
|
-
- **Everything in one place:** Documents, Markdown files, Obsidian vaults, web links, and exported AI chats come into one wiki.
|
|
44
|
+
- **Everything in one place:** Documents, Markdown files, Obsidian vaults, Logseq graphs, web links, and exported AI chats come into one wiki.
|
|
45
45
|
- **One wiki for all your AI tools:** Claude Code, Codex, Cursor, and other MCP clients work from the same pages.
|
|
46
46
|
- **Built in, not bolted on:** Saving, organizing, citing, and updating pages live in one app, with no maze of plugins to wire up.
|
|
47
47
|
|
|
@@ -69,7 +69,7 @@ Prefer the terminal? [Use Wenlan through the CLI or AI tools](docs/setup-and-dat
|
|
|
69
69
|
|
|
70
70
|
### 2. Create a page or import existing material
|
|
71
71
|
|
|
72
|
-
Create a page in Wenlan, connect an Obsidian vault, or import earlier AI conversations and memories. [Import guide](docs/import-guide.md).
|
|
72
|
+
Create a page in Wenlan, connect an Obsidian vault or a Logseq graph, add a folder, or import earlier AI conversations and memories. [Import guide](docs/import-guide.md).
|
|
73
73
|
|
|
74
74
|
### 3. Connect an AI tool when you want
|
|
75
75
|
|
|
@@ -87,7 +87,9 @@ Imported material is ready to use right away, and you can turn it into pages whe
|
|
|
87
87
|
|
|
88
88
|
In Codex, use `$recall`. With an MCP-only tool, just ask: “Check Wenlan for my earlier notes and decisions on this, then help me: …”
|
|
89
89
|
|
|
90
|
-
|
|
90
|
+
To turn imported material into cited pages, run `/wenlan steep` (`$wenlan steep` in Codex). New installs [steep](#steep-keep-knowledge-useful-as-it-changes) On demand, with your AI tool; switch to Automatic with a [model](docs/steep.md#enable-steep) to organize memories and update pages in the background.
|
|
91
|
+
|
|
92
|
+
Not sure what to ask? Open **What your AI can do** in the App for the exact text to type in your AI tool.
|
|
91
93
|
|
|
92
94
|
<a id="what-does-wenlan-build"></a>
|
|
93
95
|
<a id="why-it-compounds"></a>
|
|
@@ -105,7 +107,14 @@ Later, you can turn on [Steep](#steep-keep-knowledge-useful-as-it-changes) with
|
|
|
105
107
|
|
|
106
108
|
## Organize scattered material into knowledge
|
|
107
109
|
|
|
108
|
-
|
|
110
|
+
<a id="explore-your-personal-knowledge-graph"></a>
|
|
111
|
+
|
|
112
|
+
<p align="center">
|
|
113
|
+
<img src="./docs/assets/wenlan-personal-graph.png" alt="Wenlan knowledge graph with illustrative regions for personal interests, research, and development" width="100%">
|
|
114
|
+
</p>
|
|
115
|
+
<p>App nodes and connections; translated labels and illustrative regions.</p>
|
|
116
|
+
|
|
117
|
+
**Sources** preserve documents and conversations; **memories** keep the decisions, lessons, and reasons worth reusing. Combine them in editable **Markdown pages with citations**, connect pages with `[[wikilinks]]`, and follow citations back to the originals. Pages can include Mermaid diagrams, which the App draws; when an AI tool writes a page, Wenlan checks its diagrams for common mistakes and names the line to fix.
|
|
109
118
|
|
|
110
119
|
- **Atomic memories:** Following [Zettelkasten’s principle of atomicity](https://zettelkasten.de/posts/create-zettel-from-reading-notes/), keep findings independently retrievable and reusable without loading an entire conversation or page.
|
|
111
120
|
- **Shared topics:** With an enrichment model configured, LLM entity extraction and entity resolution link mentions of the same person, project, or concept across documents and conversations, retaining their memories and sources.
|
|
@@ -115,21 +124,14 @@ Later, you can turn on [Steep](#steep-keep-knowledge-useful-as-it-changes) with
|
|
|
115
124
|
|
|
116
125
|
| Bring in | How you can use it |
|
|
117
126
|
| --- | --- |
|
|
118
|
-
| Markdown, text, text-based PDFs, or a folder | Search and cite the imported text
|
|
119
|
-
| An Obsidian vault | Search and cite existing
|
|
127
|
+
| Markdown, text, text-based PDFs, or a folder | Search and cite the imported text. Import a folder once, or keep it in sync as its files change. |
|
|
128
|
+
| An Obsidian vault or a Logseq graph | Search and cite existing pages through a read-only connection. Keep it in sync to follow changes in the background, or import it once; nothing is written back. |
|
|
120
129
|
| Web excerpts with a URL | Paste the text and its URL to save searchable material with a link to the original. |
|
|
121
|
-
| ChatGPT or Claude export ZIPs | Retrieve earlier conversation text and cite it as context; imports are snapshots, not live account connections. |
|
|
130
|
+
| ChatGPT or Claude export ZIPs | Retrieve earlier conversation text, including a last message that got no reply, and cite it as context; imports are snapshots, not live account connections. |
|
|
122
131
|
| Existing memories as text | Save preferences, decisions, or lessons as individual memories. |
|
|
123
132
|
|
|
124
133
|
Scanned PDFs need text extraction first; chat attachments are not imported. [Import guide](docs/import-guide.md).
|
|
125
134
|
|
|
126
|
-
<a id="explore-your-personal-knowledge-graph"></a>
|
|
127
|
-
|
|
128
|
-
<p align="center">
|
|
129
|
-
<img src="./docs/assets/wenlan-personal-graph.png" alt="Wenlan knowledge graph with illustrative regions for personal interests, research, and development" width="100%">
|
|
130
|
-
</p>
|
|
131
|
-
<p>App nodes and connections; translated labels and illustrative regions.</p>
|
|
132
|
-
|
|
133
135
|
<a id="daily-workflow"></a>
|
|
134
136
|
|
|
135
137
|
<br>
|
|
@@ -145,7 +147,7 @@ Save new findings and progress as you work, then pick up where you left off next
|
|
|
145
147
|
Simplified workflow. Plugin commands and page organization are optional, with no fixed sequence.
|
|
146
148
|
|
|
147
149
|
- **Work in the App.** Add material, write or edit pages, follow citations, and review proposed changes without connecting AI.
|
|
148
|
-
- **Use your knowledge and write new pages.** Ask your AI to find relevant sources and memories for the task (`/recall`). It can also write cited pages or update existing ones from their current version, then save them to Wenlan.
|
|
150
|
+
- **Use your knowledge and write new pages.** Ask your AI to find relevant sources and memories for the task (`/recall`). It can also write cited pages or update existing ones from their current version, then save them to Wenlan. When a page cites its sources as `[n]`, Wenlan checks the cited source supports each sentence, and does not save the page when too many citations fail.
|
|
149
151
|
- **Keep what you learn.** Save a decision or lesson, with its reasons and sources, in the App or through your AI (`/capture`).
|
|
150
152
|
- **Pause and resume.** Save findings and a session log, update affected pages, and record progress and next steps in the project Brief (`/handoff`). Pick up that context next time (`/brief`).
|
|
151
153
|
|
|
@@ -178,10 +180,20 @@ Once your material is in Wenlan, your AI tools can build on it: retrieve earlier
|
|
|
178
180
|
- **Graph-assisted ranking:** Shared-entity links boost related memories even when their wording differs. Optional cross-encoder reranking compares each candidate with the question to refine the order.
|
|
179
181
|
- **Space-scoped retrieval:** Select a Space to limit returned knowledge to the relevant project or personal collection.
|
|
180
182
|
|
|
181
|
-
**Coming soon:** Coding repository support in Spaces.
|
|
182
|
-
|
|
183
183
|
Turn on **Web access** in Settings to let supported web AI clients such as Claude, ChatGPT, or Muse search your library or a chosen Space while your computer is online. When you allow an app, choose search only or search and write; a write app can also add, edit and delete, and AI apps can ask you before each change. This feature is experimental; queries and results pass through a relay. See the [privacy limits](docs/PRIVACY.md#pre-release-standalone-wenlan-relay-connector).
|
|
184
184
|
|
|
185
|
+
<a id="code-repository-wiki"></a>
|
|
186
|
+
|
|
187
|
+
<br>
|
|
188
|
+
|
|
189
|
+
## A wiki for your code repository
|
|
190
|
+
|
|
191
|
+
Run `/wenlan wiki` (`$wenlan wiki` in Codex) in a repository. Your AI tool plans the wiki from the repository itself: an overview that lists every page, then one page for each part or flow a newcomer needs. A small tool gets a few pages, a large monorepo many more. A rerun writes only the pages that are missing. `/wenlan wiki` replaces `/wenlan map`, with no alias for the old name.
|
|
192
|
+
|
|
193
|
+
- **Tied to the code:** Each key sentence records the code lines it was read from. When that code changes, the page shows what changed with one Review button, and steep brings the page up to date.
|
|
194
|
+
- **In the repository as a pull request:** The GitHub button on a Space connects it to its repository and puts the pages that rely on that code in the repository's `wiki/` folder as a pull request. Run it from the button, or turn on the daily update. The same pull request fixes sentences in the repository's own docs that the code no longer agrees with, for you to review.
|
|
195
|
+
- **Your edits stay:** A wiki page someone edited in the repository keeps that edit. Pages that cite your memories or chats stay out of the repository.
|
|
196
|
+
|
|
185
197
|
<a id="what-makes-wenlan-distinct"></a>
|
|
186
198
|
<a id="why-is-wenlan-different"></a>
|
|
187
199
|
<a id="two-lifecycles"></a>
|
|
@@ -197,19 +209,27 @@ Turn on **Web access** in Settings to let supported web AI clients such as Claud
|
|
|
197
209
|
|
|
198
210
|
## Steep: keep knowledge useful as it changes
|
|
199
211
|
|
|
212
|
+
<p align="center">
|
|
213
|
+
<img src="./docs/assets/wenlan-updates-history.png" alt="Illustrative flow: a finding in a source document updates memory from V1 to V2, then informs a page that is either updated automatically or sent for review." width="100%">
|
|
214
|
+
</p>
|
|
215
|
+
<p>Illustration based on current update behavior; not an App screenshot.</p>
|
|
216
|
+
|
|
200
217
|
Saving material is only the start. **Steep prepares it for reuse and keeps supported pages current**, so you and your AI can build on earlier findings instead of repeatedly working through the originals.
|
|
201
218
|
|
|
219
|
+
Choose one of two modes in Settings:
|
|
220
|
+
|
|
221
|
+
- **On demand** (new installs start here): when your AI tool saves or writes into Wenlan, it steeps as it goes, with no command needed. To finish the rest at once, run `/wenlan steep`: it writes new pages from imported material and brings out-of-date pages up to date.
|
|
222
|
+
- **Automatic:** Wenlan steeps in the background with the model you assign.
|
|
223
|
+
|
|
224
|
+
What steep does:
|
|
225
|
+
|
|
202
226
|
- **Enrich memories:** Add types, structured details, search cues, and graph links so individual findings are easier to retrieve in context.
|
|
203
|
-
- **Follow the evidence:** Changed sources or
|
|
227
|
+
- **Follow the evidence:** Changed sources, memories, or cited code flag dependent pages for refresh; new memories can enrich eligible pages. Refresh keeps the saved page if a draft fails citation checks. Passing these checks does not establish factual correctness.
|
|
204
228
|
- **Keep control and history:** Background refresh updates eligible AI-maintained pages; your authored or edited pages receive proposed revisions. Explicit memory replacements hide or archive earlier memories while preserving their links. Page revisions remain inspectable.
|
|
229
|
+
- **Review lock:** With **Lock pages I've written** on, as it is for new installs, AI changes to pages you wrote or edited wait for your review. Pages AI wrote keep updating.
|
|
205
230
|
|
|
206
231
|
[Steep guide: triggers, review rules, and model setup](docs/steep.md). Choose an on-device model, a local server, or a cloud provider; model-backed background work is optional.
|
|
207
232
|
|
|
208
|
-
<p align="center">
|
|
209
|
-
<img src="./docs/assets/wenlan-updates-history.png" alt="Illustrative flow: a finding in a source document updates memory from V1 to V2, then informs a page that is either updated automatically or sent for review." width="100%">
|
|
210
|
-
</p>
|
|
211
|
-
<p>Illustration based on current update behavior; not an App screenshot.</p>
|
|
212
|
-
|
|
213
233
|
<a id="architecture"></a>
|
|
214
234
|
|
|
215
235
|
<br>
|