Summary

SoloMD is a local-first Markdown editor acting as a bridge to LLMs, enabling AI agents to directly interact with a local Markdown vault. It offers a WYSIWYG editing experience, a built-in agent surface, and an MCP endpoint for LLM clients like Claude Code and Cursor. Prioritizing user privacy and control, it keeps all data, keys, and history on the user's machine, supporting 14 AI providers.

How It Works

Built on Tauri 2, Vue 3, and CodeMirror 6, SoloMD combines a rich Markdown editor with a bundled MCP server (solomd-mcp). This server exposes the vault to external LLM clients. The editor features an Agent Panel for streamed chat-with-vault, inline tool-call cards, and declarative YAML agent recipes triggered by events. These recipes operate within an AutoGit branch sandbox, allowing review before merging changes to the main vault.

Quick Start & Requirements

• Installation: macOS via Homebrew (brew install --cask zhitongblog/solomd/solomd), Windows installers (MSI/NSIS/portable), Linux .AppImage/.deb/.rpm. A one-line shell install script is available.
• Prerequisites: For source builds: Rust (stable), Node 18+, pnpm. Linux requires libdbus-1-dev.
• Resource Footprint: macOS DMG ~32 MB; Windows installer ~10 MB.
• Links: Download v4.0, Launch post, How we built it, Website, Security.

Highlighted Details

• Agent Surface (v4.0): Streamed chat-with-vault, inline tool-call cards, and declarative YAML recipes with configurable triggers and write caps.
• AutoGit Sandbox: Agent operations commit to separate AutoGit branches for review before merging.
• Replayable Agent Trace: Generates trace.jsonl detailing steps for debugging and replay.
• AI Provider Support: Integrates 14 BYOK providers, including first-class support for local Ollama.
• Bundled MCP Server: solomd-mcp offers 13 tools (5 proprietary) for LLM client integration, supporting multi-vault federation.
• GitHub-backed Sync: Optional E2EE sync to private Git repositories.

Maintenance & Community

• Maintainer: Single maintainer (xiangdong li).
• Community: GitHub Discussions, Telegram chat (@SOLOMDAPP).
• Roadmap: docs/roadmap.md.

Licensing & Compatibility

• License: MIT.
• Compatibility: Permissive MIT license allows commercial use and integration.

Limitations & Caveats

• Bus Factor: Single maintainer.
• Linux Keychain: Requires libdbus-1-dev.
• Agent Safety: Complex agent interactions require monitoring despite sandboxing.