verint.com/obsidian-mcp
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

docs: clarify Obsidian must be running before using MCP tools (fixes #4)

Browse Source 
- Add prominent note in Prerequisites that Obsidian must be open and running
- Expand Troubleshooting section with explanation of why the error occurs and how to fix it

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
Peter Morton
2026-04-16 09:22:57 -05:00
parent 57b58a0d22
commit 82d2409fe3
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -19,7 +19,9 @@ An MCP (Model Context Protocol) Bundle that exposes Obsidian CLI capabilities to
- Node.js >= 18.0.0 - Node.js >= 18.0.0
- Obsidian CLI installed and configured - Obsidian CLI installed and configured
- Obsidian application installed - Obsidian application installed and **running**
> **Important:** The Obsidian application must be open and running before using any MCP tools. The CLI used by this bundle communicates with the running Obsidian instance. If Obsidian is not running, commands will launch the GUI instead of executing — start Obsidian first, then use the MCP tools.
### Install via Claude Desktop ### Install via Claude Desktop
@@ -194,7 +196,9 @@ Contributions are welcome! Please ensure:
### "Obsidian not running" error ### "Obsidian not running" error
Start the Obsidian application before using MCP tools. The Obsidian application must be running before using any MCP tools. The CLI communicates with the running Obsidian instance — if Obsidian is closed, commands will launch the GUI app instead of executing.
**Fix:** Open the Obsidian application and wait for it to fully load, then retry the operation.
### "Vault not found" error ### "Vault not found" error