Quick Configuration
Choose the setup that matches your environment.
Before You Start
- Confirm you have the account, endpoint, or API key required for Obsidian.
- Start with minimum scopes and read-only access where possible.
- Keep secrets in environment variables instead of hardcoding them in JSON.
uvx mcp-obsidianLocal config
JSON{
"obsidian": {
"command": "uvx",
"args": ["mcp-obsidian"],
"env": {
"OBSIDIAN_API_KEY": "${OBSIDIAN_API_KEY}",
"OBSIDIAN_HOST": "127.0.0.1"
}
}
}After copying
Check the Obsidian JSON before running it in OpenClaw, then verify the server with a real prompt.
Verify prompt
Search my vault for notes mentioning "MCP" and summarize the key points.
Expected success output
You should see matching notes from your vault with short summaries.
Common Pitfalls & Fixes
- ⚠️ Watch out: Vault path scope, linking conventions, and avoiding accidental edits.
- 🔑 Always store API keys in environment variables, never hardcode them in JSON.
- 🛡️ Start with read-only scopes if available to verify connection safely.
Security checklist
- The Local REST API exposes your vault locally; keep OBSIDIAN_API_KEY secret and bind to 127.0.0.1.
- Prefer read and search workflows before enabling note edits.
Common errors
Vault path
Confirm Obsidian has the intended vault open, the Local REST API plugin is enabled, and the config points to the correct local port.
File permissions
If connection works but notes cannot be read, check vault file permissions, sync-client locks, and OBSIDIAN_API_KEY.
Sync conflicts
Validate read and search workflows before enabling writes. Avoid multiple clients modifying the same note at the same time.
| Error | Cause | Fix |
|---|---|---|
Connection refused | Obsidian or the Local REST API plugin is not running. | Open Obsidian and enable the Local REST API plugin, then retry. |
401 Unauthorized | OBSIDIAN_API_KEY is wrong. | Copy the key from the Local REST API plugin settings into OBSIDIAN_API_KEY. |
No results | The wrong vault is open or it has no matching notes. | Confirm the intended vault is open in Obsidian. |
Example Prompts
Once connected, try these prompts to test capabilities:
- Search my vault for notes about "MCP" and summarize the key takeaways.
- Find all notes tagged #todo and extract a task list grouped by topic.
- Create a draft note "Weekly Review" that links to the 5 most recently edited notes.
Verification Checklist
- Run 1-2 real prompts to confirm Obsidian returns usable data.
- Check that error messages are clear enough for troubleshooting.
- Document the required scopes, dependencies, and env vars for future reuse.
FAQ
How should I set the vault path?
Confirm the intended vault is open in Obsidian, and the Local REST API plugin is enabled and bound to 127.0.0.1.
What if file permissions are insufficient?
Obsidian Local REST API requires vault files to be readable. Check filesystem permissions and ensure OBSIDIAN_API_KEY is correct.
How do I avoid sync conflicts?
Prefer read and search workflows before enabling note edits. Avoid multiple clients modifying the same file simultaneously.