wenlan-mcp 0.17.6 → 0.17.7
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 +15 -22
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -26,9 +26,7 @@ Useful work with AI shouldn't disappear when a conversation ends. Wenlan builds
|
|
|
26
26
|
<a href="#learn-more">Learn more</a>
|
|
27
27
|
</p>
|
|
28
28
|
|
|
29
|
-
|
|
30
|
-
<img src="./docs/assets/desktop-wiki-preview.png" alt="Wenlan desktop app showing a source-backed wiki page with inspectable citations." width="100%">
|
|
31
|
-
</p>
|
|
29
|
+
https://github.com/user-attachments/assets/77272089-84ea-4eb0-a074-c9cc8b7b28fd
|
|
32
30
|
|
|
33
31
|
<p align="center">
|
|
34
32
|
<sub>A maintained Page in the desktop app: open any citation to inspect the Source or Memory behind the claim.</sub>
|
|
@@ -49,17 +47,13 @@ Wenlan runs as one local daemon. The desktop app carries that daemon inside it;
|
|
|
49
47
|
|
|
50
48
|
### Desktop app
|
|
51
49
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
Nothing else to install. The app bundles the daemon, CLI, and MCP connector, starts the daemon on launch, and offers to connect the AI clients it detects: the plugin for Claude Code and Codex, an MCP entry for the rest. From there you read Pages, inspect the Source behind any citation, and curate the knowledge system.
|
|
50
|
+
Download from the [Releases page](https://github.com/7xuanlu/wenlan/releases/latest):
|
|
55
51
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/7xuanlu/wenlan/main/scripts/install-macos-app.sh)"
|
|
60
|
-
```
|
|
52
|
+
- **macOS (Apple Silicon):** open the `.dmg` and drag Wenlan to Applications. The app is signed and notarized, so there is no warning on first launch. From the terminal instead: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/7xuanlu/wenlan/main/scripts/install-macos-app.sh)"` (downloads, checks the SHA-256, moves it to Applications).
|
|
53
|
+
- **Windows x64:** run the `-setup.exe`. It is not signed yet, so when SmartScreen says "Windows protected your PC", choose "More info", then "Run anyway".
|
|
54
|
+
- **Linux:** no desktop build yet; use the headless runtime below.
|
|
61
55
|
|
|
62
|
-
|
|
56
|
+
The app bundles the daemon, CLI, and MCP connector, starts the daemon on launch, and offers to connect the AI clients it detects: the plugin for Claude Code and Codex, an MCP entry for the rest. To upgrade, drag the new app over the old one and open it (Wenlan 0.17.0 and older must be quit by hand first).
|
|
63
57
|
|
|
64
58
|
<a id="claude-code-in-30-seconds"></a>
|
|
65
59
|
|
|
@@ -88,6 +82,8 @@ Need only the headless runtime on macOS Apple Silicon?
|
|
|
88
82
|
npx -y wenlan setup
|
|
89
83
|
```
|
|
90
84
|
|
|
85
|
+
`npx` requires Node.js; without it, run `curl -fsSL https://raw.githubusercontent.com/7xuanlu/wenlan/main/install.sh | bash` then `wenlan setup --basic`.
|
|
86
|
+
|
|
91
87
|
This downloads the prebuilt CLI, daemon, and MCP connector, starts the local runtime, and verifies it. No Rust toolchain or Cargo is required. Linux x64/ARM64 with glibc has an automated [shell setup path](docs/setup-with-ai.md#install-the-runtime); Windows x64 uses the matching archive from [Releases](https://github.com/7xuanlu/wenlan/releases/latest). macOS Intel currently has [no supported complete-runtime install](crates/wenlan-cli/README.md#macos-intel).
|
|
92
88
|
|
|
93
89
|
Manual and client-specific instructions: [AI-assisted setup](docs/setup-with-ai.md) · [Claude Code plugin](plugin/.claude-plugin/README.md) · [Codex plugin](plugin-codex/README.md) · [CLI and MCP](crates/wenlan-cli/README.md).
|
|
@@ -127,10 +123,6 @@ For the complete workflow, see the [LLM-wiki implementation guide](https://wenla
|
|
|
127
123
|
|
|
128
124
|
**Wenlan's distinctive move:** Sources and atomic Memories independently support maintained Pages. Memory history preserves how knowledge changed; Page history shows which current evidence supports the synthesis. Machine-maintained Pages can rebuild from current support, while changes to human writing wait as reviewable revisions.
|
|
129
125
|
|
|
130
|
-
<p align="center">
|
|
131
|
-
<img src="./docs/assets/feature-reel.gif" alt="Wenlan feature reel showing source-backed pages, source inspection, graph context, agent capture, and curation." width="100%">
|
|
132
|
-
</p>
|
|
133
|
-
|
|
134
126
|
<a id="knowledge-graph"></a>
|
|
135
127
|
|
|
136
128
|
### A knowledge graph that gets more useful over time
|
|
@@ -151,7 +143,7 @@ Within the entity graph, a configured enrichment model extracts typed Entities,
|
|
|
151
143
|
- **Communities that compound:** Label propagation groups Entities by relation density, weighted by the relation count between each pair. These groups can organize optional corpus summaries while Entity links add retrieval context.
|
|
152
144
|
- **Correction without erasure:** Related claims, corrections, and explicit supersession stay inspectable together while original Sources and Memory history remain.
|
|
153
145
|
|
|
154
|
-
During retrieval, dense entity matching finds query-relevant entities. When eligible graph links exist, the default graph-memory stream boosts linked Memories as a third [RRF](https://cormack.uwaterloo.ca/cormacksigir09-rrf.pdf) signal. The path is data- and scope-dependent, and Space boundaries still apply. [How the graph path works ->](docs/technical-foundations.md#graph-assisted-retrieval)
|
|
146
|
+
During retrieval, dense entity matching finds query-relevant entities. When eligible graph links exist, the default graph-memory stream boosts linked Memories as a third [RRF](https://cormack.uwaterloo.ca/cormacksigir09-rrf.pdf) signal. The path is data- and scope-dependent, and Space boundaries (Spaces are defined under Capabilities) still apply. [How the graph path works ->](docs/technical-foundations.md#graph-assisted-retrieval)
|
|
155
147
|
|
|
156
148
|
<a id="retrieval"></a>
|
|
157
149
|
|
|
@@ -268,8 +260,8 @@ The system above becomes a small daily loop: start with relevant knowledge, capt
|
|
|
268
260
|
|
|
269
261
|
The loop has four steps:
|
|
270
262
|
|
|
271
|
-
1. **
|
|
272
|
-
2. **
|
|
263
|
+
1. **Capture and find knowledge while you work.** `/capture <thing>` saves a decision, lesson, gotcha, or fact with its source. `/recall <query>` retrieves only what is relevant instead of loading your whole history.
|
|
264
|
+
2. **Find current knowledge.** Open a relevant Page, search, or use `/recall <query>`; `/brief [topic]` reads the Brief — the Space's rolling project snapshot, first written by `/handoff` — and a topic appends separately labeled context from that same Space. Clients without plugin commands use the equivalent page, search, recall, and brief tools.
|
|
273
265
|
3. **Close the loop.** `/handoff` records what changed and applies typed item-level updates to the current Space Brief.
|
|
274
266
|
4. **Keep the wiki current.** `/distill` deliberately creates or refreshes pages. Between sessions, optional model-backed passes can enrich captures, connect related entities, and refresh eligible pages. `/lint` checks knowledge health; `/curate` brings proposed revisions and any conflict-review items created by the optional reconcile pass to you.
|
|
275
267
|
|
|
@@ -291,7 +283,7 @@ Full workflow reference: [plugin/skills](plugin/skills/README.md). Technical mod
|
|
|
291
283
|
|
|
292
284
|
Nothing is locked in. Pages and session notes are Markdown under `~/.wenlan/`; memories live in one libSQL database under the platform data directory (`~/Library/Application Support/wenlan/` on macOS, `~/.local/share/wenlan/` on Linux, `%LOCALAPPDATA%\wenlan\` on Windows). Copy those two folders to back up or move a Wenlan. An install upgraded from Origin still holds a full copy of its data in `~/.origin/` and in the sibling `origin` data folder (`~/Library/Application Support/origin/` on macOS, `~/.local/share/origin/` on Linux, `%LOCALAPPDATA%\origin\` on Windows); delete or copy those two as well.
|
|
293
285
|
|
|
294
|
-
To uninstall: the app's *Run Wenlan in background at login* toggle removes the launch registration — turn it off, quit, and delete `Wenlan.app` or run the Windows uninstaller, then delete the folders above. `wenlan background off` only stops the daemon and disables autostart; it does not remove the launch registration, so a CLI-only install should instead follow the daemon uninstall bullet in [PRIVACY.md](PRIVACY.md). The paths Wenlan writes are listed there.
|
|
286
|
+
To uninstall: the app's *Run Wenlan in background at login* toggle removes the launch registration — turn it off, quit, and delete `Wenlan.app` or run the Windows uninstaller, then delete the folders above. `wenlan background off` only stops the daemon and disables autostart; it does not remove the launch registration, so a CLI-only install should instead follow the daemon uninstall bullet in [PRIVACY.md](docs/PRIVACY.md). The paths Wenlan writes are listed there.
|
|
295
287
|
|
|
296
288
|
---
|
|
297
289
|
|
|
@@ -328,6 +320,7 @@ More detailed documentation, concepts, and comparisons:
|
|
|
328
320
|
- [Build an investment research knowledge base](https://wenlan.app/learn/build-investment-research-knowledge-base)
|
|
329
321
|
- [Build a product research knowledge base before writing a PRD](https://wenlan.app/learn/build-product-research-knowledge-base-for-prd)
|
|
330
322
|
- [Build an SRE incident knowledge base](https://wenlan.app/learn/build-sre-incident-knowledge-base)
|
|
323
|
+
- [Build a business metric definition knowledge base](https://wenlan.app/learn/build-business-metric-definition-knowledge-base): turn approved KPI specifications into a source-backed data dictionary with formula text, grain, exclusions, owners, revisions, and review state.
|
|
331
324
|
|
|
332
325
|
### Concepts
|
|
333
326
|
|
|
@@ -361,7 +354,7 @@ pnpm dev:all
|
|
|
361
354
|
pnpm build:all
|
|
362
355
|
```
|
|
363
356
|
|
|
364
|
-
`pnpm dev:all` is the supported development entry point for the desktop app. It keeps development ports, data, process ownership, app identity, MCP sockets, and Remote Access state separate from the installed production runtime; a debug app started without that isolation refuses to run. See this repository's [AGENTS.md](AGENTS.md) and [CONTRIBUTING.md](CONTRIBUTING.md), plus the in-tree [app/AGENTS.md](app/AGENTS.md), for the complete development workflow. Security reports: [SECURITY.md](SECURITY.md). Privacy policy: [PRIVACY.md](PRIVACY.md). Please also read the [Code of Conduct](CODE_OF_CONDUCT.md).
|
|
357
|
+
`pnpm dev:all` is the supported development entry point for the desktop app. It keeps development ports, data, process ownership, app identity, MCP sockets, and Remote Access state separate from the installed production runtime; a debug app started without that isolation refuses to run. See this repository's [AGENTS.md](AGENTS.md) and [CONTRIBUTING.md](.github/CONTRIBUTING.md), plus the in-tree [app/AGENTS.md](app/AGENTS.md), for the complete development workflow. Security reports: [SECURITY.md](.github/SECURITY.md). Privacy policy: [PRIVACY.md](docs/PRIVACY.md). Please also read the [Code of Conduct](.github/CODE_OF_CONDUCT.md).
|
|
365
358
|
|
|
366
359
|
---
|
|
367
360
|
|
|
@@ -377,7 +370,7 @@ Free code signing provided by [SignPath.io](https://about.signpath.io), certific
|
|
|
377
370
|
|
|
378
371
|
Multi-factor authentication is required of every maintainer, on GitHub and on SignPath, and nobody is added to either without it. Releases are built only by the tagged release workflow in this repository, on GitHub-hosted runners, from the commit the tag points at.
|
|
379
372
|
|
|
380
|
-
**Privacy policy:** [PRIVACY.md](PRIVACY.md) — what Wenlan stores, where it stores it, and each case we know of in which it reaches the network. How each platform is signed: [docs/code-signing.md](docs/code-signing.md).
|
|
373
|
+
**Privacy policy:** [PRIVACY.md](docs/PRIVACY.md) — what Wenlan stores, where it stores it, and each case we know of in which it reaches the network. How each platform is signed: [docs/code-signing.md](docs/code-signing.md).
|
|
381
374
|
|
|
382
375
|
The SignPath application is pending. Windows installers are not signed yet.
|
|
383
376
|
|