Read and search a folder of Markdown notes: search, backlinks, tags, tasks, outlines, git history.
# SoloMD
> The editor where agents live.
[](https://github.com/zhitongblog/solomd/releases/latest)
[](LICENSE)
[](https://github.com/zhitongblog/solomd/releases/latest)
[](LICENSE)
[: Using this exact human-architect + Claude Code pipeline, the maintainer also built Unterm — a self-developed Rust + wgpu terminal kernel exposing 152 MCP methods with an Action Gateway. Available for 100% asynchronous remote contracts (custom MCP servers, Rust/Tauri agentic desktop apps, and AI workflows — written specs, Loom demos & clean PRs, zero meetings). Work with the architect →
Your notes live in a folder. SoloMD is the editor on top — with a first-class agent surface inside the editor, and the MCP endpoint Claude Code / Cursor can drive from outside. Same .md files. Chat with your vault. Schedule recipes that run when you're not at the keyboard. Hand the same vault to any MCP client.
Built on Tauri 2 + Vue 3 + CodeMirror 6. Universal macOS dmg ~32 MB. Free, MIT, no subscription, no SoloMD-hosted servers. Your notes, AI keys, embeddings index, and git history all stay on your machine.
New in 4.6 — the knowledge-graph layer
The structural half Obsidian and Tolaria had and SoloMD didn't — now built, and on SoloMD's own warm design system:
Properties inspector (⌘⇧I) — edit YAML frontmatter with type/date/status/relation pickers; line-surgical writes preserve your comments, inline arrays and quoting byte-for-byte.
Type-driven sidebar — give a note type: Project and its members become a first-class collapsible section with custom icon/colour/columns (types-as-lenses).
Typed relationships — belongs_to / related_to / has frontmatter with automatic inverses, resolved server-side for big vaults.
Relationship graph ("Neighborhood") — per-note explorer of outgoing + inverse links; click to navigate, ⌘-click to pivot.
Saved filtered views — persistent sidebar views (.solomd/views/*.yml) with a recursive all/any filter builder (type / status / date / regex).
Inbox workflow — ⌘E mark-organized + auto-advance to inbox-zero.
tldraw whiteboards — Markdown-backed boards (```tldraw fence), cross-compatible with Tolaria's on-disk format, lazy-loaded so the core stays light.
Plus a unified macOS title bar (traffic lights inline in the toolbar) and a from-scratch design-system + Vue component library. Still ~15–32 MB, still free, still local-first. → Compare vs Obsidian / Typora / Tolaria
The endpoint. A bundled solomd-mcp binary exposes the same vault to any MCP client — 16 tools out of the box, including SoloMD-only ones (autogit_log, autogit_diff, autogit_rollback, sync_status, share_url, read_agent_trace) that no other markdown server has. v4.0 adds --workspace path1 --workspace path2 federation — one MCP session, many vaults. Plus a solomd agent <prompt> CLI that hands off to Claude Code / Codex CLI with the MCP pre-wired.
The agent surface (v4.0). Right-side Agent Panel: streamed chat-with-vault, [[wikilink]] citations, tool-call cards inline, Insert / Copy buttons drop the reply into the active note. Plus declarative recipes as YAML in <workspace>/.solomd/agents/*.yml — cron / on-save / on-commit / on-tag-add / manual triggers. Every agent write lands on its own AutoGit branch you accept or reject before it touches main; write-cap default 5; refuses to start when the working tree is dirty; replayable trace.jsonl per run with read_agent_trace MCP tool.
Feature
Agent Panel(v4.0)
Streamed chat-with-vault peer to Outline / Backlinks / Tags / History. Tool-call cards expand inline; reply Insert / Copy to active editor; run history persists as plain markdown under .solomd/agent-runs/.
Scheduled recipes(v4.0)
YAML jobs in your vault. AutoGit branch sandbox + accept/reject UI before merge. Per-run write-cap (default 5, ceiling 50). 11-recipe cookbook ships in-tree.
Replayable trace(v4.0)
trace.jsonl per step (prompt / model_call / tool_call / tool_result / git_commit). Replay-from-step rewinds and re-executes.
Workspace federation(v4.0)
solomd-mcp --workspace path1 --workspace path2. One Claude Desktop session, many vaults. MCP profiles UI in Settings → Integrations.
Ollama first-class(v4.0)
Auto-detect at localhost:11434. Three model presets (qwen2.5:1.5b/7b/14b). provider: local recipe alias for zero-cloud-cost autonomous loops.
AI rewrite, BYOK
14 providers — OpenAI · Claude · Gemini · DeepSeek · Qwen · GLM · Kimi · Doubao · SiliconFlow · OpenRouter · Mistral · Groq · xAI · Ollama. Direct vendor calls. Keys in OS keychain.
GitHub-backed sync
Push your vault to a private GitHub repo on every save. Optional E2EE (Argon2id + XChaCha20-Poly1305). GitLab / Gitea / any HTTPS git URL works too.
AutoGit per note
Every ⌘S is a commit in a local .git inside the workspace. libgit2 vendored, no system git needed. Never auto-pushed.
MCP server bundled
solomd-mcp ships in the install. 16 tools (see the list). stdio by default; opt-in Streamable HTTP (--transport http, loopback + bearer token). Read-only by default; --allow-write opt-in.
REST API(v4.0)
Localhost only, token auth. Same surface as MCP for clients that don't speak MCP yet — Alfred / Raycast / n8n / your own scripts.
If your vault lives in ~/Library/Mobile Documents/... or ~/Dropbox/..., SoloMD detects it and adds cross-device session restore on top — the OS already does the file sync.
Public read-only share
Command palette → copy solomd.app/share/?repo=...&path=... link. Renders any file in your public GitHub repo, no SoloMD account needed to view.
Use it
After installing SoloMD on macOS / Linux:
1. Chat with your vault. Open the right-side Agent Panel (⌘⇧P → "View: Toggle Agent Panel" if hidden). Streamed multi-turn against your notes; tool-call cards show every read/write inline. Reply too long? Insert drops it into the active note at the cursor (replaces selection); Copy to clipboard.
2. Schedule a recipe. Settings → Recipes → Browse cookbook. 11 starters ready: weekly review, daily summary, TODO extraction, translation pass, citation cleanup, CJK proofread agent, link-rot detector, frontmatter normalizer, outline-to-blog, refactor pass, weekly tag triage. Install one, edit the prompt, run it.
3. Drive the same vault from another LLM client. One-shot (needs the solomd CLI):
# Print the MCP config snippet for your AI client…
solomd mcp-config
# …or write it straight into every AI client found on this machine.
solomd mcp install
export_note (html / md / txt / docx) runs the headless exporter with Node.js, so it is only listed when a SoloMD source checkout with pnpm install is available (or SOLOMD_EXPORT_SCRIPT points at its app/scripts/solomd-export.mjs); it never overwrites an existing file unless the call passes overwrite: true. Line numbers in every tool count from the top of the file, front matter included.
Transports: stdio (default, what Claude Desktop / Cursor / Cline / Codex use), or Streamable HTTP for hosted clients:
HTTP binds to loopback by default; with --auth-token (or SOLOMD_MCP_TOKEN) every request needs Authorization: Bearer <token>. See mcp-server/README.md.
Command line (CLI)
solomd is a small bash CLI (macOS / Linux) for scripting the vault and wiring up MCP:
curl -fsSL https://raw.githubusercontent.com/zhitongblog/solomd/main/scripts/install-cli.sh | bash
solomd help
open, new, list, search, cat, agent, mcp list|install|uninstall|config, mcp-config, --version; every command takes -h. The notes folder is $SOLOMD_NOTES (default ~/Documents/SoloMD). solomd export uses the same Node exporter as export_note, so it needs a source checkout: run scripts/solomd from a clone with pnpm install done in app/, or set SOLOMD_EXPORT_SCRIPT. In the app itself, use File → Export.
System requirements: Windows 10+, macOS 10.15+, current mainstream Linux, iOS 15+, Android 7+ (API 24).
Windows 7/8/8.1 cannot be supported — the Rust toolchain requires Windows 10 (since Rust 1.78) and Microsoft froze WebView2 (SoloMD's rendering engine) at version 109 on Windows 7 with no security updates — and no legacy build exists.
The bundled solomd-mcp server runs against any folder of Markdown files — you don't need to install SoloMD itself to drive your vault from Claude / Cursor / Cline / Continue / Zed. Install snippets for each:
Skill Pack (solomd-skills-v<version>.zip on the releases page) — 11 reference Agent Recipes (weekly review, todo extract, link suggester, …) you can drop into <vault>/.solomd/agents/. Ships with every release.
Claude Code Skill — SKILL.md + install.sh that registers solomd-mcp as a user-scope MCP server and exposes its 16 tools to Claude Code with patterns and starter recipes.
Smithery — smithery.yaml + Dockerfile at marketplace/smithery/ (submission pending).
Awesome MCP Servers — PR entries for the three biggest community indices (punkpeye/, appcypher/, wong2/awesome-mcp-servers, ~14k forks combined) at marketplace/awesome-mcp/.
Pure client-side. Your .md files stay in the folder you chose. API keys live in the OS keychain (macOS Keychain / Windows Credential Manager / Linux libsecret), never in localStorage or any config file. AI requests go direct from your machine to the provider you picked — no SoloMD relay. RAG embeddings and the AutoGit repo are local-only. The MCP server speaks stdio by default; its optional HTTP transport binds to loopback unless you choose otherwise, and can require a bearer token. The whole codebase is MIT and auditable.
Agent safety rails (v4.0). Every recipe run starts on its own AutoGit branch — your main stays untouched until you click Accept on the diff. Per-run write-cap (default 5, hard ceiling 50) prevents runaway loops. Recipe runner refuses to start when the working tree is dirty (no agent commit will ever sweep your work-in-progress). Path-traversal guards reject .. segments and absolute paths upfront in every Tauri / MCP / REST endpoint that accepts a user-supplied path.
E2EE sync uses Argon2id (RFC9106 default params) → XChaCha20-Poly1305 with deterministic nonces and path-as-AAD. Plaintext stays on your devices; the remote sees only ciphertext. Failed sync.json parsing is fail-closed — refuses to push rather than degrading to plaintext (a v3.0.x audit fix).
git clone https://github.com/zhitongblog/solomd.git
cd solomd/app
pnpm install
pnpm tauri dev # dev with hot reload
pnpm tauri build # release artifacts → src-tauri/target/release/bundle/
Linux additionally needs libdbus-1-dev for the keychain backend.
The MCP server is a separate crate at mcp-server/; the dev MCP harness used for end-to-end testing lives at dev-mcp/. End-to-end test entry point: scripts/v4-self-test.sh (run with --with-release --with-ollama --with-ui for full coverage).
WeChat (中文): scan to add me — note "SoloMD" 注明 SoloMD 直接通过
Sponsors
Thank you to everyone who sponsors SoloMD: tyysoft(太阳雨)
(Note: This is a partial opt-in list — WeChat Pay, Alipay, and App Store / Google Play in-app tips are anonymous by default. If you supported SoloMD and would like your name listed, please open an issue or see solomd.app/thanks.)
✨ 100% Free Forever & Supporter Badge: Every feature in SoloMD is 100% free forever — no paywalls, no subscriptions, no ads. To support independent open-source development, you can sponsor via GitHub Sponsors / PayPal / Alipay / WeChat Pay, or use the 3 optional one-time in-app tip tiers on Mac App Store, iOS App Store, and Google Play (☕ Buy a Coffee $0.99 · 🍜 Buy a Lunch $2.99 · 🚀 Generous Support $9.99) to permanently unlock the exclusive ✨ Supporter badge in Settings and About.
Contributors
Thank you to everyone who helps make SoloMD better — sponsors 💵, testers 🐛🤔, code/theme/packaging contributors 💻🎨📦 and promoters 📣 (All Contributors spec). Full wall of thanks: solomd.app/thanks · Promote SoloMD: solomd.app/promote
