SoloMD logo

SoloMD

Local MCP access to Markdown vaults for search, links, tasks, outlines, tags, and Git history.

Install SoloMD

Run the project’s own setup commands, in order.

Setup steps from the project

SoloMD installs with its own commands rather than a config we can generate, so these are copied as-is. Run them in order in a terminal. Source: github.com

  1. 1. Configure
    solomd mcp-config
    
  2. 2. Run
    solomd mcp install
    
  3. 3. Start the server
    solomd-mcp --workspace ~/Documents/SoloMD --transport http --bind 127.0.0.1:8765 --auth-token "$TOKEN"
    
  4. 4. Install
    curl -fsSL https://raw.githubusercontent.com/zhitongblog/solomd/main/scripts/install-cli.sh | bash
    
  5. 5. Run
    mcp list|install|uninstall|config
    
  6. 6. Install
    curl -fsSL https://solomd.app/install.sh | bash
    

Overview

SoloMD MCP server exposes a local folder of Markdown notes to Claude Desktop, Claude Code, Cursor, and other MCP clients. Its bundled `solomd-mcp` binary provides 16 tools for searching notes, traversing backlinks, inspecting tags and tasks, reading outlines, and reviewing Git history. It uses stdio by default, can optionally serve Streamable HTTP on loopback with bearer-token authentication, and can federate multiple workspaces in one session. Reach for SoloMD when an agent needs structured access to an existing local Markdown vault without moving notes to a hosted service.

Use cases

  • Search a local Markdown vault from an MCP-compatible coding assistant
  • Trace backlinks and tags while researching related notes
  • Review tasks and outlines across a workspace
  • Inspect or roll back note changes through AutoGit history
  • Query multiple Markdown workspaces from one MCP session

Key features

  • 16 MCP tools for Markdown vault access
  • Search, backlinks, tags, tasks, and outlines
  • AutoGit logs, diffs, rollback, and sync status
  • Stdio transport with optional Streamable HTTP
  • Multi-workspace federation
  • Read-only default with opt-in writes

Security & health

What it can reach and how reliably it runs — from our own checks, not the maintainer’s claims.

ActiveLast checked Today

Recent health check succeeded.

41/41 checks healthy over the last 37d

Adoption & maintenance

Factual signals from GitHub, npm, and our automated checks — not a rating.

GitHub stars1.6kStargazers on the source repository.
Last commit1d agoMost recent push to the default branch.

How SoloMD works

What SoloMD MCP server does

SoloMD connects MCP clients to Markdown notes stored in one or more local workspaces. It exposes the same vault used by the SoloMD editor, allowing an agent to search and inspect notes without requiring a separate copy or hosted knowledge base.

The endpoint includes 16 tools covering note search, backlinks, tags, tasks, outlines, and Git history. It also includes SoloMD-specific operations for AutoGit logs, diffs, rollback, synchronization status, share URLs, and agent traces. Read access is the default; write access must be explicitly enabled.

How it works

The bundled solomd-mcp executable communicates over stdio unless another transport is selected. MCP clients can therefore launch it as a local process and query the configured workspace directly. Version 4.0 added workspace federation: one MCP session can be started with multiple workspace paths.

For clients that use HTTP instead of stdio, SoloMD supports opt-in Streamable HTTP on loopback. That mode uses a bearer token. The MCP endpoint operates on the same .md files as the desktop editor, while local Git data can provide note history and recovery operations.

Setup and configuration

Install SoloMD on macOS or Linux to obtain the bundled solomd-mcp binary. The command-line interface can print an MCP configuration snippet with solomd mcp-config, or install configuration into AI clients detected on the machine with solomd mcp install.

A single workspace can be passed to the server, or multiple paths can be supplied with repeated --workspace options, such as --workspace path1 --workspace path2. The default stdio transport requires no network listener. Enable HTTP with --transport http; loopback binding and bearer-token authentication apply in that mode. Use --allow-write when an MCP client must modify the vault.

Tools and capabilities

  • Search Markdown notes, including semantic search through the SoloMD application.
  • Inspect backlinks and linked-note relationships.
  • Find tags and tasks across a workspace.
  • Read note outlines.
  • Review AutoGit history, diffs, and synchronization status.
  • Roll back changes when write access is enabled.
  • Read replayable agent traces from recipe runs.
  • Work across multiple federated workspaces in one MCP session.

Limitations and notes

SoloMD is local-first: notes, API keys, embeddings indexes, and Git history remain on the machine. The MCP server is read-only unless --allow-write is supplied. HTTP access is an opt-in local mode rather than a general public endpoint, and it requires bearer-token authentication.

The server is bundled with the SoloMD desktop application and is intended for Markdown folders managed by SoloMD. Agent recipe writes use AutoGit branches and require acceptance or rejection before reaching the main branch; recipes also refuse to start when the working tree is dirty. SoloMD is released under the MIT license.

Reviews

No reviews yet — be the first to share how it worked for you.

Frequently Asked Questions about SoloMD

SoloMD is an MCP server that connects Claude Desktop, Claude Code, Cursor, and other MCP clients to local Markdown workspaces. Its 16 tools support note search, backlinks, tags, tasks, outlines, and Git history, with additional tools for AutoGit operations, synchronization status, share URLs, and agent traces.

Install SoloMD on macOS or Linux, then use `solomd mcp-config` to print an MCP configuration snippet or `solomd mcp install` to configure detected AI clients. The bundled `solomd-mcp` binary uses stdio by default.

Yes, SoloMD works with Cursor through its bundled MCP endpoint. Use `solomd mcp-config` for the configuration snippet or `solomd mcp install` to write configuration into detected clients.

Yes, SoloMD can federate multiple workspaces in one MCP session. Start the server with multiple `--workspace` arguments, such as `--workspace path1 --workspace path2`.

Start `solomd-mcp` with `--allow-write` to opt into write access. The server is read-only by default, so clients cannot modify the vault without that flag.

Related MCP servers

Add a badge to your READMEShow it’s listed — live SVG, Markdown or HTML.

AllMCPs Directory Badge

Full Badge Customizer

Showcase your server listing on GitHub or your project documentation. Embed this dynamic SVG badge to highlight official listing status and live engagement.

Badge Style:
Live Dynamic SVG PreviewSoloMD AllMCPs Directory Badge
Markdown (GitHub README)
[![AllMCPs](https://allmcps.com/api/badge/solomd?style=directory)](https://allmcps.com/mcp/solomd)
HTML Embed
<a href="https://allmcps.com/mcp/solomd"><img src="https://allmcps.com/api/badge/solomd?style=directory" alt="SoloMD on AllMCPs" /></a>