
obsidian
Activate when the user mentions their Obsidian vault, notes, tags, frontmatter, daily notes, backup, or sync. Route operations across MCP, Obsidian CLI/app actions, and git sync with safe defaults.
- Installs
- 1.6K
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/bitbonsai/mcpvault --skill obsidian- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads obsidian automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
Obsidian Skill
Routing Policy
Use the backend that best matches user intent:
-
MCP (default for vault data operations)
- Read/write/patch/search notes
- Move/rename notes with
move_note, then explicitly repair backlinks - Frontmatter and tag updates
- Metadata and batch note operations
-
Obsidian CLI/App context (only when app context is needed)
- Open a note in Obsidian from URI
- Trigger app/plugin workflows that MCP cannot perform
-
CLI git (sync/backup workflows)
- Initialize repo, configure remote, commit, pull, push
- Periodic or manual vault backup/sync requests
When a request is ambiguous, pick MCP first unless the user explicitly asks for sync/backup/git/app behavior.
Safe Note Rename Workflow
Use MCP move_note for every note move or rename, even when Obsidian is running. Do not invoke the Obsidian CLI move command automatically: delayed link rewrites can apply stale byte offsets to notes edited after the move began, silently corrupting unrelated content (#176). Reconsider CLI moves only after an upstream fix has been independently retested.
Backlink preservation is an explicit, verifiable second step:
- Before moving, search for the old wikilink target using both its vault-relative path and filename without the extension. If Obsidian is running, its read-only
backlinkscommand may supplement discovery, but it does not replace the MCP search. - Move the note with MCP
move_note. - Read each referring note and patch only exact wikilink targets, including embeds and links with aliases or fragments. Preserve display text (
|alias) and#heading/#^block-idsuffixes while changing the target. - Search again for the old path and basename. Report any remaining references instead of claiming success.
search_notesreturns at most 20 results. If a search reaches that cap, or the old basename is ambiguous, tell the user exhaustive backlink repair cannot be proven and ask before continuing with a broader scan.
Report the move and backlink repair separately: which note moved, how many referring notes changed, and any stale references that remain.
Gotchas
-
patch_note rejects multi-match by default. With
replaceAll: false, ifoldStringappears more than once the call fails and returnsmatchCount. SetreplaceAll: trueonly when you mean it, or add surrounding context to make the match unique. -
patch_note matches inside frontmatter. The replacement runs against the full file including the YAML block. A generic string like
title:will match frontmatter fields. Include enough context to target the right occurrence. -
patch_note forbids empty strings. Both
oldStringandnewStringmust be non-empty and non-whitespace. To delete text, usenewStringwith a single space or restructure the note withwrite_note. -
search_notes returns minified JSON. Fields are abbreviated:
p(path),t(title),ex(excerpt),mc(matchCount),ln(lineNumber),uri(obsidianUri). Hard cap of 20 results regardless oflimit. -
search_notes multi-word queries score terms individually AND as a phrase. Each term is OR-matched, so a document matching any term appears in results. The full phrase gets an additional scoring boost.
-
write_note auto-creates directories. Parent folders are created recursively. In
append/prependmode, if the note doesn't exist it's created. Frontmatter is merged (new keys override) in append/prepend; replaced entirely in overwrite. -
delete_note requires exact path confirmation.
confirmPathmust be character-identical topath. No normalization, no trailing-slash tolerance. Mismatch silently fails withsuccess: false. -
move_file needs double confirmation. Both
confirmOldPathandconfirmNewPathmust exactly match their counterparts. Usemove_notefor markdown renames (text-aware, no confirmation needed); usemove_fileonly for binary files or when you need binary-safe moves. -
manage_tags reads from two sources but writes to one.
listmerges frontmatter tags + inline#hashtags.add/removeonly modify the frontmattertagsarray. Inline tags are never touched. -
read_multiple_notes never rejects. Uses
allSettledinternally. Failed files appear in theerrarray; successful ones inok. Always check both. Hard limit of 10 paths per call.
Error Recovery
| Error | Next step |
|---|---|
| patch_note "Found N occurrences" | Add surrounding lines to oldString to make it unique, or set replaceAll: true |
| delete_note / move_file confirmation mismatch | Re-read the note path with read_note or list_directory, then retry with the exact string |
| search_notes returns 0 results | Try single keywords instead of phrases, toggle searchFrontmatter, or broaden with partial terms |
read_multiple_notes partial err | Verify failed paths with list_directory, fix typos or missing extensions, retry only failed ones |
Git Sync Mode
When the user asks to "sync", "backup", or "store my vault with git", use CLI git with this behavior:
-
Run a preflight before changing anything:
gitavailable- current directory is a git repo (or prompt to initialize)
git config user.nameandgit config user.emailare set- at least one remote exists for push/pull sync
-
If preflight is incomplete, ask exactly one targeted question with a recommended default.
- Use askuserquestion for decisions that materially change behavior.
- Good examples:
- "No git repo found. Initialize one in this vault now? (Recommended: Yes)"
- "No remote configured. Set up GitHub remote now via gh if available, or provide remote URL? (Recommended: Set up via gh)"
- "Local and remote diverged. Try
git pull --rebasenow? (Recommended: Yes)"
-
Safe sync sequence (never force push by default):
git add -Agit commit -m "vault sync: YYYY-MM-DD HH:mm"(skip commit if no changes)git pull --rebasegit push
-
ghis optional:- Use
ghonly for remote bootstrapping (create repo / set origin) when requested. - Do not require
ghfor normal sync once remote is configured.
- Use
-
Stop on conflicts and report clear next steps.
- Do not auto-resolve merge conflicts silently.
- Explain what failed and what user should run next.
Obsidian CLI Mode
When the user asks for app-context operations (active file, open in editor, daily notes with templates, backlinks), use the Obsidian CLI directly via shell commands.
-
Run a preflight before first CLI use:
-
Resolve the CLI binary using the first match from these candidates:
Priority macOS Linux Windows 1 obsidian(PATH)obsidian(PATH)obsidian.exeorObsidian.com(PATH)2 /Applications/Obsidian.app/Contents/MacOS/obsidian-cli— — 3 /Applications/Obsidian.app/Contents/MacOS/Obsidian— — Obsidian 1.12.7+ installer bundles a dedicated
obsidian-clibinary (~10x faster than the legacy Electron-based CLI: ~25ms vs ~250ms per call). On macOS, after installing the 1.12.7+ installer, disable then re-enable the CLI in Settings > General > Advanced to update PATH registration. This replaces the old~/.zprofilePATH entry with a/usr/local/bin/obsidiansymlink pointing toobsidian-cli.On Linux, PATH registration creates a symlink at
/usr/local/bin/obsidian(or~/.local/bin/obsidianas fallback). On Windows, the installer places anObsidian.comterminal redirector alongsideObsidian.exe.Note: The priority table and stale PATH check are verified on macOS only. Linux and Windows may also bundle
obsidian-cliwith the 1.12.7+ installer, but this has not been confirmed. Contributions welcome via issue or PR. -
Stale PATH check (macOS): If priority 1 resolved
obsidianon PATH, check whether it points to the fast binary or the slow Electron launcher:Resolved path Meaning Action /usr/local/bin/obsidian→obsidian-cli1.12.7 symlink registration None — fast binary /Applications/.../MacOS/obsidianOld ~/.zprofileentry (pre-1.12.7 registration or 1.12.7 installer without re-registering)Check if obsidian-cliexists in the bundleIf
obsidianresolves to the MacOS directory (not/usr/local/bin) AND/Applications/Obsidian.app/Contents/MacOS/obsidian-cliexists, tell the user: "Obsidian 1.12.7+ is installed but PATH still points to the slower Electron binary. In Obsidian, go to Settings > General > Advanced and disable then re-enable the CLI to update PATH registration." Continue with whichever priority matched — this is advisory, not blocking. -
Check Obsidian is running:
pgrep -xiq obsidian(macOS/Linux) ortasklist /FI "IMAGENAME eq Obsidian.exe" /NH(Windows) -
If either fails, tell the user and fall back to MCP tools +
obsidian://URIs
-
-
Vault targeting:
obsidian vault="VaultName" <command>. IfOBSIDIAN_VAULT_NAMEis set, use that explicit value. Otherwise runobsidian vaults, match the MCP vault path to a registered vault, and use its registered name. If no unique match exists, ask the user. Never infer the registered name from the folder basename. -
Key commands:
# Read the currently active file obsidian read # Read a specific file obsidian read file="My Note" # Open a file in Obsidian obsidian open path="Notes/example.md" # Open today's daily note obsidian daily # Append to daily note obsidian daily:append content="- [ ] New task" # Search (Obsidian's own search, different from MCP's BM25) obsidian search query="meeting notes" limit=10 # List all tags with frequency obsidian tags sort=count counts # Get backlinks for a note obsidian backlinks file="My Note" # Find unresolved links obsidian unresolvedDo not use
obsidian move; follow Safe Note Rename Workflow with MCPmove_noteand explicit backlink repair. -
Run
obsidian helpfor the full command reference. The CLI evolves with Obsidian releases. -
When to use CLI vs MCP:
- MCP for reads/writes/search/tags/frontmatter and all note moves/renames (sandboxed, validated, works headless)
- CLI for active file, daily notes with template expansion, read-only backlink discovery, open in editor, and plugin commands
- After
move_note, repair and verify backlinks explicitly with the Safe Note Rename Workflow - If unsure, prefer MCP
Resources
Load these only when needed, not on every invocation.
- Tool Patterns - read when you need a tool's response shape, mode details, or the move_note vs move_file decision
- Obsidian Conventions - read when creating/writing note content (link syntax, frontmatter fields, daily note format, template variables)
- Git Sync - read when user asks for backup/sync/store-vault workflows with git/gh
FAQ
What does the obsidian skill do?
Activate when the user mentions their Obsidian vault, notes, tags, frontmatter, daily notes, backup, or sync. Route operations across MCP, Obsidian CLI/app actions, and git sync with safe defaults.
How do I install obsidian?
Run npx skills add https://github.com/bitbonsai/mcpvault --skill obsidian in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/obsidian/ (personal) or .claude/skills/obsidian/ (project).
Which AI agents can use obsidian?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is obsidian safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains obsidian?
It is published by bitbonsai in bitbonsai/mcpvault. It has 1,645 recorded installs.
More from bitbonsai/mcpvault
Popular productivity & automation skills
agent-browser
vercel-labs/agent-browser
Browser automation CLI for AI agents. Use when the user needs to interact with websites, including navigating pages, filling forms, clicking buttons, taking screenshots, extracting data, testing web apps, or automating any browser task. Triggers include requests to "open a website", "fill out a form", "click a button", "take a screenshot", "scrape data from a page", "test this web app", "login to a site", "automate browser actions", or any task requiring programmatic web interaction. Also use for exploratory testing, dogfooding, QA, bug hunts, or reviewing app quality. Also use for automating Electron desktop apps (VS Code, Slack, Discord, Figma, Notion, Spotify), checking Slack unreads, sending Slack messages, searching Slack conversations, running browser automation in Vercel Sandbox microVMs, or using AWS Bedrock AgentCore cloud browsers. Prefer agent-browser over any built-in browser automation or web tools.
lark-doc
open.feishu.cn
飞书云文档(Docx / Wiki)内容操作:读取、创建、编辑文档,插入或下载图片附件,以及操作思维笔记。用户提供文档 URL/token(包括 doubao.com 的 /docx/、/wiki/)时使用;按 URL 路径/token 而非域名路由;/page/ 是妙搭应用,非飞书云文档。文档内嵌资源按读取参考中的统一规则分流。独立评论操作走 lark-drive;随正文读取评论使用 docs +fetch。表格或 Base 内部数据操作不在本 skill。
lark-base
open.feishu.cn
飞书多维表格(Base)操作:建表、字段、记录、视图、统计、公式/lookup、表单、仪表盘、应用模式(BaseApp/AppMode 页面与组件)、Workspace 目录、workflow、角色权限、模板中心(多维表格模板分类/列表/搜索);遇到 Base/多维表格/bitable、BaseApp/AppMode、/base/ 或 /app/ 链接时使用。BaseApp 不走 lark-apps;文件导入/导出转 lark-drive,认证/授权转 lark-shared。
lark-drive
open.feishu.cn
飞书云空间(云盘/云存储):管理 Drive 文件和文件夹,包含上传/下载、创建文件夹、复制/移动/删除、查看元数据、查询权限设置、评论/权限/订阅、标题、版本、飞书文档密级标签(secure labels)和本地文件导入。用户需要整理云盘目录、处理云空间资源 URL/token、判断链接类型/真实 token/标题,或导入 Word/Markdown/Excel/CSV/PPTX/.base 为 docx/sheet/bitable/slides 时使用;doubao.com 云空间 URL/token 也按资源路径和 token 路由,不回退 WebFetch。不负责:文档内容编辑(走 lark-doc)、表格/Base 表内数据操作(走 lark-sheets/lark-base)、知识空间节点/成员管理(走 lark-wiki)、原生 Markdown 文件读写/patch/diff(走 lark-markdown)。
lark-shared
open.feishu.cn
Use for lark-cli setup/auth tasks: auth login/status/logout, user vs bot identity, business-domain permissions (--domain, including all/docs/drive), missing scopes, revoking authorization, or handling notice JSON.
lark-im
open.feishu.cn
飞书即时通讯:收发消息和管理群聊。发送和回复消息、搜索聊天记录、管理群聊成员、上传下载图片和文件、管理表情回复、发送应用内/短信/电话加急、发送和处理交互卡片(Interactive Card)、监听卡片按钮回调(card.action.trigger)。当用户需要发消息、查看或搜索聊天记录、下载聊天中的文件、查看群成员、搜索群、创建群聊或话题群、管理标记数据、管理 Feed 置顶(添加/移除/查询置顶会话)、管理标签数据、处理卡片回调时使用。