obsidian

bitbonsai/mcp-obsidian · updated Apr 8, 2026

MDX-style export adds YAML metadata + attribution linking explainx.ai and this canonical listing URL.

$npx skills add https://github.com/bitbonsai/mcp-obsidian --skill obsidian
0 commentsdiscussion
summary

Use the backend that best matches user intent:

skill.md

Obsidian Skill

Routing Policy

Use the backend that best matches user intent:

  1. MCP (default for vault data operations)

    • Read/write/patch/move/search notes
    • Frontmatter and tag updates
    • Metadata and batch note operations
  2. 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
  3. 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.

Gotchas

  1. patch_note rejects multi-match by default. With replaceAll: false, if oldString appears more than once the call fails and returns matchCount. Set replaceAll: true only when you mean it, or add surrounding context to make the match unique.

  2. 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.

  3. patch_note forbids empty strings. Both oldString and newString must be non-empty and non-whitespace. To delete text, use newString with a single space or restructure the note with write_note.

  4. 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 of limit.

  5. 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.

  6. write_note auto-creates directories. Parent folders are created recursively. In append/prepend mode, if the note doesn't exist it's created. Frontmatter is merged (new keys override) in append/prepend; replaced entirely in overwrite.

  7. delete_note requires exact path confirmation. confirmPath must be character-identical to path. No normalization, no trailing-slash tolerance. Mismatch silently fails with success: false.

  8. move_file needs double confirmation. Both confirmOldPath and confirmNewPath must exactly match their counterparts. Use move_note for markdown renames (text-aware, no confirmation needed); use move_file only for binary files or when you need binary-safe moves.

  9. manage_tags reads from two sources but writes to one. list merges frontmatter tags + inline #hashtags. add/remove only modify the frontmatter tags array. Inline tags are never touched.

  10. read_multiple_notes never rejects. Uses allSettled internally. Failed files appear in the err array; successful ones in ok. 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:

  1. Run a preflight before changing anything:

    • git available
    • current directory is a git repo (or prompt to initialize)
    • git config user.name and git config user.email are set
    • at least one remote exists for push/pull sync
  2. 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 --rebase now? (Recommended: Yes)"
  3. Safe sync sequence (never force push by default):

    • git add -A
    • git commit -m "vault sync: YYYY-MM-DD HH:mm" (skip commit if no changes)
    • git pull --rebase
    • git push
  4. gh is optional:

    • Use gh only for remote bootstrapping (create repo / set origin) when requested.
    • Do not require gh for normal sync once remote is configured.
  5. 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.

  1. Run a preflight before first CLI use:

    • Check binary exists: /Applications/Obsidian.app/Contents/MacOS/obsidian (macOS), obsidian (Linux), obsidian.exe (Windows)
    • Check Obsidian is running: pgrep -xiq obsidian (macOS/Linux) or tasklist /FI "IMAGENAME eq Obsidian.exe" /NH (Windows)
    • If either fails, tell the user and fall back to MCP tools + obsidian:// URIs
  2. Vault targeting: obsidian vault="VaultName" <command>. The vault name is the folder basename unless OBSIDIAN_VAULT_NAME is set.

  3. 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 unresolved
    
  4. Run obsidian help for the full command reference. The CLI evolves with Obsidian releases.

  5. When to use CLI vs MCP:

    • MCP for reads/writes/search/tags/frontmatter (sandboxed, validated, works headless)
    • CLI for active file, daily notes with template expansion, backlinks, open in editor, plugin commands
    • 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
how to use obsidian

How to use obsidian on Cursor

AI-first code editor with Composer

1

Prerequisites

Before installing skills in Cursor, ensure your development environment meets these requirements:

  • Cursor installed and configured on your development machine
  • Node.js version 16.0+ with npm package manager (verify with node --version)
  • Active project directory or workspace where you want to add obsidian
2

Execute installation command

Execute the skills CLI command in your project's root directory to begin installation:

$npx skills add https://github.com/bitbonsai/mcp-obsidian --skill obsidian

The skills CLI fetches obsidian from GitHub repository bitbonsai/mcp-obsidian and configures it for Cursor.

3

Select Cursor when prompted

The CLI will show a list of available agents. Use arrow keys to navigate and space to select Cursor:

◆ Which agents do you want to install to?
│ ── Universal (.agents/skills) ── always included ────
│ • Amp
│ • Antigravity
│ • Cline
│ • Codex
│ ●Cursor(selected)
│ • Cursor
│ • Windsurf
4

Verify installation

Confirm successful installation by checking the skill directory location:

.cursor/skills/obsidian

Reload or restart Cursor to activate obsidian. Access the skill through slash commands (e.g., /obsidian) or your agent's skill management interface.

Security & Verification Notice

We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.

Skills execute code in your development environment. Always verify the publisher's identity, review recent commits, and test in isolated environments before production deployment.

List & Monetize Your Skill

Submit your Claude Code skill and start earning

GET_STARTED →

Use Cases

User Story & Requirements Generation

Create detailed user stories, acceptance criteria, and feature specs

Example

Generate user stories for 'password reset feature' with acceptance criteria, edge cases, and test scenarios

Reduce spec writing time by 50%, ensure comprehensive coverage

Competitive Analysis

Research competitors, compare features, identify gaps

Example

Analyze 5 competitor products, create feature comparison matrix, suggest differentiation opportunities

Complete competitive research in 2 hours instead of 2 days

Roadmap Prioritization

Evaluate features using frameworks (RICE, ICE, Kano) and create prioritized backlogs

Example

Score 20 feature ideas using RICE framework, generate prioritized roadmap with rationale

Make data-driven prioritization decisions faster

Stakeholder Communication

Draft PRDs, status updates, and stakeholder presentations

Example

Create executive summary of Q3 roadmap, monthly progress report, feature launch announcement

Save 3-5 hours/week on communication overhead

Implementation Guide

Prerequisites

  • Claude Desktop or compatible AI client
  • Access to product documentation and roadmap tools (Jira, Notion, etc.)
  • Understanding of product management frameworks (RICE, Jobs-to-be-Done, etc.)
  • Stakeholder contact information and communication channels

Time Estimate

30-60 minutes to see productivity improvements

Installation Steps

  1. 1.Install product management skill
  2. 2.Start with user story generation for known feature
  3. 3.Progress to competitive analysis: research 2-3 competitors
  4. 4.Use for roadmap prioritization: apply RICE/ICE scoring
  5. 5.Draft stakeholder communications and refine based on feedback
  6. 6.Build template library for recurring PM tasks
  7. 7.Share effective prompts with product team

Common Pitfalls

  • Not validating competitive research—verify facts before sharing
  • Accepting user stories without involving engineering team
  • Over-relying on frameworks without qualitative judgment
  • Not customizing outputs to company culture and communication style
  • Skipping stakeholder validation of generated requirements

Best Practices

✓ Do

  • +Validate research and competitive analysis with real data
  • +Collaborate with engineering when generating technical requirements
  • +Customize frameworks and templates to your company context
  • +Use skill for first drafts, refine with stakeholder input
  • +Document successful prompt patterns for PM tasks
  • +Combine AI efficiency with human judgment and intuition

✗ Don't

  • Don't publish competitive analysis without fact-checking
  • Don't finalize user stories without engineering review
  • Don't make prioritization decisions solely on AI scoring
  • Don't skip customer validation of generated requirements
  • Don't ignore company-specific context and culture

💡 Pro Tips

  • Provide context: company goals, constraints, customer feedback
  • Ask for alternatives: 'Show 3 ways to prioritize this roadmap'
  • Request stakeholder-specific formatting: 'Executive summary vs. engineering spec'
  • Use skill for 70% generation + 30% customization to company needs

When to Use This

✓ Use When

Use for user story writing, competitive research, roadmap prioritization, stakeholder communication, and PRD drafting. Best for reducing repetitive documentation and research work.

✗ Avoid When

Avoid for strategic product vision (requires deep customer empathy), pricing decisions (needs market and financial expertise), or when face-to-face customer discovery is more valuable than speed.

Learning Path

  1. 1Basic: user stories, feature specs, status updates
  2. 2Intermediate: competitive analysis, prioritization frameworks, PRDs
  3. 3Advanced: product strategy, go-to-market planning, OKR setting
  4. 4Expert: product vision, market positioning, business model innovation

Discussion

Product Hunt–style comments (not star reviews)
  • No comments yet — start the thread.
general reviews

Ratings

4.541 reviews
  • Yuki Gill· Dec 28, 2024

    obsidian fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.

  • Ganesh Mohane· Dec 24, 2024

    obsidian reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • Jin Jain· Dec 20, 2024

    We added obsidian from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.

  • Kofi Kim· Nov 19, 2024

    obsidian is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.

  • Rahul Santra· Nov 15, 2024

    I recommend obsidian for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

  • Yuki Garcia· Nov 15, 2024

    obsidian has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • Henry Gill· Nov 11, 2024

    Keeps context tight: obsidian is the kind of skill you can hand to a new teammate without a long onboarding doc.

  • Kofi White· Oct 10, 2024

    Keeps context tight: obsidian is the kind of skill you can hand to a new teammate without a long onboarding doc.

  • Pratham Ware· Oct 6, 2024

    Useful defaults in obsidian — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

  • Evelyn Abbas· Oct 6, 2024

    Solid pick for teams standardizing on skills: obsidian is focused, and the summary matches what you get after install.

showing 1-10 of 41

1 / 5