Obsidian Setup Guide
Enables your agent to read, write, search, and organize notes in your Obsidian vault.
Overview
Unlike other integrations, Obsidian doesn't use an API key or token. The agent accesses your vault directly via the filesystem. You provide the absolute path to your vault directory on the machine where the agent runs.
Prerequisites
- An Obsidian vault on the local filesystem (or a synced copy accessible via a local path)
Step 1: Find Your Vault Path
- Open Obsidian
- Look at the vault name in the bottom-left corner
- Find the full path:
- macOS: Right-click the vault folder in Finder > Get Info > copy the path under "Where"
- Linux:
readlink -f /path/to/vault - Windows: Right-click > Properties > copy the Location
The path should look like:
- macOS:
/Users/yourname/Documents/MyVault - Linux:
/home/yourname/obsidian/MyVault - Windows:
C:\Users\yourname\Documents\MyVault
Step 2: Connect in Carapace
- Go to Dashboard > Connections
- Find Obsidian and click Connect
- Paste the full vault path
- Click Save Credentials
Credential Fields Reference
| Field | Required | Format | Description |
|---|---|---|---|
vault_path | Yes | Absolute filesystem path | Path to the Obsidian vault directory |
Gotchas
Filesystem access required: The agent must be able to read the vault directory from within its runtime environment. For Carapace enclaves, this means the vault must be on a mounted drive or accessible path from the CVM.
Synced vaults work via their local path: If you use Obsidian Sync, iCloud, or Dropbox, the vault has a local sync directory. Use that local path — the agent reads the synced files directly.
Dashboard labels this as "API Key": The Carapace dashboard input field is labeled "API Key" but it expects a filesystem path for Obsidian. This is a UI quirk — just paste the path.