Agent skill

Solomd

by zhitongblog in zhitongblog/solomd

Read, search, edit, and version-control any folder of Markdown notes via the SoloMD MCP server.

MITAuto-check passedKnowledge Management

Install Solomd

skills CLI
$ npx skills add zhitongblog/solomd --skill solomd -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install zhitongblog/solomd solomd --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/zhitongblog/solomd.git skills-src && mkdir -p .claude/skills && cp -r skills-src/marketplace/claude-code-skill/solomd .claude/skills/solomd && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
solomd
GitHub stars
1.2k
Token cost
~2k tokens
SKILL.md length
910 words
Files
13
Skills in repo
3
Repo updated
First seen
Licence
MIT

At a glance

Read, search, edit, and version-control any folder of Markdown notes via the SoloMD MCP server.

  • Tasks that involve Note-taking
  • SKILL.md covers When to use this skill, Setup (one-time), Tools available and Patterns, plus 4 more sections
  • Runs Shell scripts from its folder; calls claude, git and bash
  • Tasks that involve Git workflow

What it does

Solomd is an agent skill from zhitongblog/solomd. Read, search, edit, and version-control any folder of Markdown notes via the SoloMD MCP server. 13 tools including AutoGit per-note history, semantic search, and write-with-sandbox via an accept/reject branch. Includes 11 starter agent recipes (weekly review, todo extract, link suggester, …).

Its SKILL.md is about 2k tokens, which your agent loads only when the skill is triggered. The skill folder holds 13 other files (for example `install.sh`, `recipes/01-weekly-review.yml` and `recipes/02-todo-extract.yml`).

It sits in Knowledge Management, covering Note-taking, Git workflow and MCP servers. It works with Model Context Protocol, Tauri, Vue.js and Obsidian. The repository describes itself as: A markdown editor — and the bridge to your LLM. Local-first, MIT, ~15 MB. Bundled MCP server lets Claude Code / Codex / Cursor drive your vault directly. 14 AI providers BYOK. The licence is MIT.

When your agent uses it

  • Tasks that involve Note-taking
  • Tasks that involve Git workflow
  • Tasks that involve MCP servers

Example prompts

  • “/solomd”

Requirements

  • A Bash shell
  • Pre-approved tools (allowed-tools): solomd:*

What it can do on your machine

Read from SKILL.md and the folder at commit 35e8fef. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • solomd:*

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships script files (Shell), which the agent can run.

    Shell commands in SKILL.md call:

    • claude
    • git
    • bash
    • cargo

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • solomd.app

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Solomd loads about 2k tokens when it runs. Until then it costs about 75 tokens; SKILL.md has 910 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~75
When it runs · the whole SKILL.md, loaded when a task matches
~2k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from zhitongblog/solomd at commit 35e8fef, republished under its MIT licence (© zhitongblog). 910 words, ~2,042 tokens.

Download SKILL.mdSave it as .claude/skills/solomd/SKILL.md (or your agent's skills folder). This skill also uses 12 other files; get the full folder from GitHub.
name
solomd
description
Read, search, edit, and version-control any folder of Markdown notes via the SoloMD MCP server. 13 tools including AutoGit per-note history, semantic search, and write-with-sandbox via an accept/reject branch. Includes 11 starter agent recipes (weekly review, todo extract, link suggester, …).
allowed-tools
solomd:*

SoloMD — Markdown vault skill

When to use this skill

Trigger this skill when the user wants to:

  • Browse / read / search a folder of Markdown notes (their personal knowledge base, journal, project docs, etc.).
  • Maintain the vault — generate weekly summaries, extract TODOs across notes, suggest wikilinks, find orphan notes, etc.
  • Edit notes with version control — every write lands as an AutoGit commit (no network); past revisions are queryable via autogit_log / autogit_diff.
  • Share a note publicly via a solomd.app/share/?repo=…&path=… link that renders the file from a public GitHub repo (no SoloMD account required for the viewer).

If the user just wants generic file I/O on a directory, the built-in filesystem tools are simpler. This skill is specifically for Markdown-as-a-vault workflows.

Setup (one-time)

The skill assumes solomd-mcp is installed and registered as a user-scope MCP server (~/.claude.json). If /mcp doesn't list solomd, run:

bash
bash ~/.claude/skills/solomd/install.sh

This installs the binary (via cargo install solomd-mcp on macOS or downloading the prebuilt binary from https://github.com/zhitongblog/solomd/releases/latest on Linux / Windows) and registers a solomd server pointing at your notes folder via claude mcp add --scope user (falling back to patching ~/.claude.json directly when the claude CLI isn't on PATH).

Default mode is read-only. To enable the 3 write tools, re-register with --allow-write:

bash
claude mcp remove solomd -s user
claude mcp add --scope user solomd -- \
  ~/.claude/bin/solomd-mcp --workspace ~/your-notes --allow-write

Tools available

All exposed via the solomd: prefix.

Read tools (always available)
  • solomd:list_notes(workspace?, subdir?, limit=100) — list .md files.
  • solomd:read_note(workspace?, path) — full contents.
  • solomd:search(workspace?, query, mode="literal"|"regex", limit=200) — substring or regex search; returns matches with line numbers.
  • solomd:get_backlinks(workspace?, note_name) — every note that references [[<name>]].
  • solomd:list_tags(workspace?) — #tag aggregation with counts.
  • solomd:get_outline(workspace?, path) — H1/H2/H3 structure.
  • solomd:autogit_log(workspace?, path, limit=20) — per-note commit history. Each save in SoloMD is a commit.
  • solomd:autogit_diff(workspace?, path, from_revision, to_revision="HEAD") — diff between revisions of one note.
  • solomd:sync_status(workspace?) — git remote ahead/behind, dirty files, conflict state.
  • solomd:share_url(workspace?, path) — generate a public read-only solomd.app/share/… link (requires the workspace to be pushed to a public GitHub repo).
  • solomd:read_agent_trace(workspace?, run_id) — replay a past agent recipe run from its .solomd/agent-runs/<run-id>/trace.jsonl.
Write tools (need --allow-write on the server)
  • solomd:write_note(workspace?, path, content) — create or overwrite. Returns the diff against any prior version.
  • solomd:append_to_note(workspace?, path, content) — append; idempotent (won't duplicate a block already present at the bottom).
  • solomd:autogit_rollback(workspace?, path, revision) — restore a note to a past commit.
Multi-vault

If the server was started with multiple --workspace alias=/path flags, pass the workspace argument (e.g. workspace: "work" or workspace: "home") to disambiguate. Without one, the first registered workspace is the default.

Patterns

Browse before acting

When the user asks "do X across my notes", first call list_notes or search to confirm the scope. The vault might be 30 notes or 3,000 — your plan should match the size.

Always cite

When responding with information from notes, link them back as [[note-name]] (the wikilink format SoloMD uses). The user can click straight back to the source. Example:

Your three open architecture decisions are tracked in [[adr-001-storage]], [[adr-003-rate-limits]], and [[adr-007-streaming-api]].

Writes go through accept/reject — surface this

If the user is also running the SoloMD desktop app on the same vault, every write tool call lands on an agent/<recipe>/<run-id> AutoGit branch the user must accept in Settings → Recipes → Pending before it touches main. Tell the user this is happening so they know to check the app:

I've written the summary to weekly/2026-W22.md — it's pending on an AutoGit branch (agent/claude-code/abc123). Open SoloMD → Settings → Recipes → Pending to accept or reject before it lands on main.

If they're not running the app, the write lands on a branch they can inspect manually with git branch | grep agent/ and git merge / git branch -D as needed.

Show full SKILL.md (333 more words)Show less
Watch the write cap

The server enforces a per-run write cap (default 5, hard ceiling 50). If you hit it, the call returns an error and no further writes succeed in that session. Plan multi-write actions in a single dispatch rather than fanning out one-at-a-time.

Starter recipes

This skill ships 11 reference YAML recipes at recipes/. They're the same files as the SoloMD Skill Pack zip — copy any of them into <workspace>/.solomd/agents/ to enable inside SoloMD (the app's recipe runner watches that directory).

For use from Claude Code directly, treat the YAML as documentation: adapt the prompt: block into the user's request and call the appropriate MCP tools yourself. Example — 01-weekly-review.yml becomes:

Use list_notes to find every daily/*.md from the past 7 days, read each, and write weekly/{ISO-week}.md with Themes / Decisions / Open threads sections, citing each daily as [[YYYY-MM-DD]].

Recipe catalog

FileTrigger (in-app)Pattern
01-weekly-review.ymlschedule (Sun 18:00)Summarise daily/ → weekly/YYYY-WW.md
02-todo-extract.ymlon-savePull - [ ] lines into todos.md
03-translate-zh-to-en.ymlon-tag-add #translateMirror translation alongside source
04-cjk-proofread.ymlon-saveLocal-Ollama punctuation + grammar
05-citation-cleanup.ymlon-tag-add #citeBibliography normalisation
06-meeting-notes-summary.ymlon-saveGenerate decisions / actions sections
07-link-suggester.ymlon-savePropose wikilinks via semantic search
08-daily-summary.ymlschedule (daily 22:00)Roll up today's edits
09-orphan-notes.ymlschedule (weekly)Find notes with no incoming wikilinks
10-on-commit-changelog.ymlon-commitMaintain CHANGELOG.md
11-tag-classifier.ymlon-saveSuggest tags from content

When NOT to use this skill

  • The user wants generic shell or filesystem ops on non-Markdown content — use the built-in Bash / Read / Edit tools.
  • The user is editing a single file they've already opened — direct Edit is more efficient than going through read_note / write_note.
  • The vault isn't actually a SoloMD vault and the user doesn't care about wikilinks / tags / AutoGit — the 5 SoloMD-only tools become no-ops (still useful for the other 8).

About SoloMD

SoloMD is a free, MIT-licensed Markdown editor. The MCP server you just installed is bundled with the desktop app — get the app for the visual Agent panel, the accept/reject UI, and AutoGit history navigation.

© zhitongblog, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 12 other files in marketplace/claude-code-skill/solomd of zhitongblog/solomd.

  • SKILL.md
  • install.sh
  • recipes/01-weekly-review.yml
  • recipes/02-todo-extract.yml
  • recipes/03-translate-zh-to-en.yml
  • recipes/04-cjk-proofread.yml
  • recipes/05-citation-cleanup.yml
  • recipes/06-meeting-notes-summary.yml
  • recipes/07-link-suggester.yml
  • recipes/08-daily-summary.yml
  • recipes/09-orphan-notes.yml
  • recipes/10-on-commit-changelog.yml
  • recipes/11-tag-classifier.yml

Open the folder on GitHubat commit 35e8fef

Compare with similar skills

Solomd next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Solomd compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Solomd this skillzhitongblog/solomd1.2k—~2kAutomated safety check: PassMIT
Horizon App Testingpeters/horizon716—~277Automated safety check: PassMIT
Joplinalondmnt/joplin-mcp173—~897Automated safety check: PassMIT
AI BrainOotto-AI/claude-content-skills130—~1.1kAutomated safety check: PassMIT
Obsidian Project Memorybrycewang-stanford/Auto-Empirical-Research-Skills4.6k—~2.4kAutomated safety check: PassCustom licence
Qmdbreferrari/obsidian-mind5k—~1.7kAutomated safety check: PassMIT

Similar skills

  • Horizon App Testing

    peters/horizon

    Run or inspect declared iOS and Android native app tests through Horizon devicetestrun and app MCP tools.

    716 GitHub stars~277 tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Joplin

    alondmnt/joplin-mcp

    Orchestration guidance for Joplin note, notebook, and tag management tools

    173 GitHub stars~897 tokensUpdated 29 days ago
    Knowledge ManagementAuto-check passed
  • AI Brain

    Ootto-AI/claude-content-skills

    Give Claude a permanent, searchable long-term memory using an Obsidian vault as the store.

    130 GitHub stars~1.1k tokensUpdated 3 days ago
    Knowledge ManagementAuto-check passed
  • Obsidian Project Memory

    brycewang-stanford/Auto-Empirical-Research-Skills

    This skill should be used when the user asks to maintain an Obsidian knowledge base for a research project, import an existing research repository into Obsidian, keep project memory or daily notes…

    4.6k GitHub stars~2.4k tokensUpdated 5 days ago
    Knowledge ManagementAuto-check passed
  • Qmd

    breferrari/obsidian-mind

    Search the vault using QMD semantic search. An agent skill from breferrari/obsidian-mind.

    5k GitHub stars~1.7k tokensUpdated 5 days ago
    Agent WorkflowsAuto-check passed
  • Swarmvault

    swarmclawai/swarmvault

    Use SwarmVault when the user needs a local-first knowledge vault that writes durable markdown, graph, search, dashboard, review, chat-session, context-pack, task-ledger, static AI export, retrieval…

    710 GitHub stars~6.1k tokensUpdated 3 mo ago
    Knowledge ManagementAuto-check passed

More from zhitongblog/solomd

  • Store Submit

    zhitongblog/solomd

    Publish a SoloMD release to the stores that have no usable submission API — Google Play Console and Microsoft Partner Center — by driving them through the local Unzoo Browser REST API.

    1.2k GitHub stars~1.7k tokensUpdated yesterday
    Auto-check: notes
  • Competitor Feedback

    zhitongblog/solomd

    Scan competing markdown editors' user feedback (GitHub issues/discussions/releases + closed-source forums) and synthesize themes cross-referenced against SoloMD's own gaps and roadmap.

    1.2k GitHub stars~1.2k tokensUpdated yesterday
    Auto-check: notes

Questions about Solomd

What does Solomd do?

Read, search, edit, and version-control any folder of Markdown notes via the SoloMD MCP server. Solomd is an agent skill from zhitongblog/solomd. Read, search, edit, and version-control any folder of Markdown notes via the SoloMD MCP server.

When should I use Solomd?

Solomd fits situations like: tasks that involve Note-taking; tasks that involve Git workflow; tasks that involve MCP servers.

How do I install Solomd in Claude Code?

Run `npx skills add zhitongblog/solomd --skill solomd -a claude-code`. Or copy the skill folder (marketplace/claude-code-skill/solomd in zhitongblog/solomd) into .claude/skills/solomd in your project. Claude Code loads it when a task matches its description.

How do I install Solomd in Codex?

Run `npx skills add zhitongblog/solomd --skill solomd -a codex`. Or copy the skill folder (marketplace/claude-code-skill/solomd in zhitongblog/solomd) into .agents/skills/solomd in your project. Codex loads it when a task matches its description.

Can I use Solomd in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add zhitongblog/solomd --skill solomd -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/solomd, .gemini/skills/solomd, .github/skills/solomd and .opencode/skills/solomd in your project.

What does Solomd need to run?

Going by SKILL.md and its folder, Solomd needs a shell for the scripts in its folder and the command-line tools its instructions call (claude, git, bash and cargo). Our summary lists: A Bash shell. Its frontmatter pre-approves these tools: solomd:*.

Does Solomd access the network?

SKILL.md names 1 domain. As links in the text: solomd.app. This is read from the text; nothing was executed.

Is Solomd safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Solomd use?

Solomd is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Solomd use?

About 2k tokens (SKILL.md is roughly 8.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Solomd?

Skills that share tags, products or a category with Solomd: Horizon App Testing (peters/horizon, 716 stars), Joplin (alondmnt/joplin-mcp, 173 stars), AI Brain (Ootto-AI/claude-content-skills, 130 stars) and Obsidian Project Memory (brycewang-stanford/Auto-Empirical-Research-Skills, 4.6k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Solomd?

zhitongblog (a GitHub user) maintains it in zhitongblog/solomd, which has 1,198 GitHub stars. The repository holds 3 skills in this directory. The repository was last updated on October 10, 2026.

Source: zhitongblog/solomd on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.