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.
Hosted / Remote
JSON Hosted Config json
{
"obsidian": {
"url": "https://YOUR_OBSIDIAN_MCP_ENDPOINT"
}
}Local CLI (npx)
JSON Local Config json
{
"obsidian": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://YOUR_OBSIDIAN_MCP_ENDPOINT"],
"env": {
"OBSIDIAN_API_KEY": "YOUR_OBSIDIAN_API_KEY"
}
}
}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.
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.