open-zk-kb
Gives AI assistants persistent, shared memory using the Zettelkasten method, so they retain corrections, preferences, and decisions across sessions and across tools via local, hybrid search.
README
open-zk-kb
You open a new session and your agent has no idea who you are. Again. You re-explain your stack, your conventions, that one edge case you've corrected five times.
open-zk-kb gives your agent a memory — so corrections stick, context compounds, and every session starts smarter than the last.
<p align="center"> <a href="docs/pi.md"> <img src="assets/pi-demo.gif" alt="Store, apply, inspect, and remove an automatic preference in Pi" width="760"> </a> <br> <sub>The full loop in Pi: store a preference, carry it into a fresh session, inspect the vault, and remove it when it stops being useful.</sub> </p>
Quick start
Requires Bun — install with
curl -fsSL https://bun.sh/install | bash
bunx open-zk-kb@latest
The installer configures your selected clients, installs agent instructions, and creates a local vault. Supported clients: OpenCode, Claude Code, Cursor, Windsurf, Zed, Pi, and OMP.
See the Setup Guide for manual installation and troubleshooting.
Why open-zk-kb?
Your agent starts from zero every session. No memory, no learning curve. You correct the same mistakes, re-explain the same conventions, re-teach the same context. Switch tools and it's even worse — your Cursor agent doesn't know what your Claude agent learned.
open-zk-kb fixes that.
- Correct it once, it sticks — your agent stores corrections, preferences, and decisions. Next session, it already knows.
- Works across every tool — one knowledge base shared by Claude Code, Cursor, Windsurf, OpenCode, Zed, Pi, and OMP
- Finds what's relevant — hybrid search matches meaning, not just keywords, so only useful context surfaces
- Runs locally — no API keys, no cloud, works offline. Your data stays on your machine.
- Human-readable — plain Markdown files you can browse, edit, and version control
- Open source — MIT licensed
Pi: native knowledge tools
Install the Pi package, then restart Pi:
pi install npm:open-zk-kb
The extension exposes all ten knowledge-* tools directly in Pi. Results use Pi-native compact rendering: search, store, context, and health have focused summaries and expandable detail, while the other tools show concise status output. The MCP server and local SQLite/embedding work still run with Bun >= 1.0; Pi itself runs under its supported Node.js runtime. Installing Bun is therefore required even when using the Pi package.
Pi also loads active project preferences automatically when a session starts and injects them into model context without requiring a model-initiated search. The visible knowledge-context entry reports what happened without fabricating a tool call.
See the Pi experience guide for the complete preference workflow and renderer examples. For installer-managed instructions, verification, and troubleshooting, see Pi installation.
Configuration
Zero configuration required. Local embeddings work out of the box with no API key.
See the Configuration Guide for embeddings, vault path, lifecycle tuning, and server settings.
Under the hood
Built on the Zettelkasten method — atomic, linked notes with structured kinds. Each note captures one concept (a decision, a preference, a gotcha) and links to related notes, building an interconnected knowledge graph.
Search combines SQLite FTS5 full-text indexing with local vector embeddings (MiniLM-L6-v2) for semantic matching. Markdown files are the source of truth; the database is a rebuildable index.
Telemetry
When enabled (telemetry.enabled: true and telemetry.share: true), open-zk-kb sends one anonymous event for each completed session to PostHog (EU Cloud) on a later startup. It includes a canonical client, bounded model IDs, vault size, and counts for all ten tools—not note content, queries, paths, names, or email addresses. Runtime defaults are disabled; the interactive installer enables sharing only after affirmative consent, while unattended and direct package installs remain disabled unless configured separately. Set DO_NOT_TRACK=1 to unconditionally block sharing (local SQLite counters are unaffected), or keep both flags false. See Telemetry for the full event schema and details.
Documentation
- Setup Guide — installation, client-specific setup, troubleshooting
- Pi Experience — native tools, automatic preferences, and renderer gallery
- Tools Reference — all 10 MCP tools with parameters and examples
- Note Lifecycle — note kinds, statuses, review system
- Configuration — embeddings, vault, lifecycle, and server settings
- Architecture — dual storage, ownership model, design decisions
- Development — local dev, testing, debugging
- Contributing — guidelines for contributors
License
推荐服务器
Baidu Map
百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。
Playwright MCP Server
一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。
Magic Component Platform (MCP)
一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。
Audiense Insights MCP Server
通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。
VeyraX
一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。
graphlit-mcp-server
模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。
Kagi MCP Server
一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。
e2b-mcp-server
使用 MCP 通过 e2b 运行代码。
Neon MCP Server
用于与 Neon 管理 API 和数据库交互的 MCP 服务器
Exa MCP Server
模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。