Obsidian Local REST API
Connect your Obsidian vault to Compass Desktop so your AI agents can read, search, and interact with your notes. This guide walks you through installing the Local REST API community plugin and configuring it for Compass.
Obsidian desktop app installed and a vault already open. Compass Desktop installed and signed in.
Open Obsidian Settings
Launch Obsidian and click the gear icon in the bottom-left corner of the sidebar to open Settings.
Navigate to Community Plugins
In the left sidebar of the Settings panel, select Community plugins.
If community plugins are disabled, click Turn on community plugins and confirm the prompt. This enables the plugin ecosystem.
Find & Install the Local REST API Plugin
Click the Browse button to open the community plugins catalogue. In the search bar, type:
Local REST API
Select Local REST API by Adam Coddington from the results, then click Install.
Enable the Plugin
After installation, click the Enable button on the plugin page — or go back to the Installed plugins list and toggle it on.
Enable the HTTP Server
Open the plugin's settings (click the gear icon next to the toggle). Find the option:
Turn it on. This allows Compass Desktop to communicate with the plugin over your local network.
The HTTP server only listens on
127.0.0.1 (localhost) by default. Traffic never leaves your machine. The API key (next step) adds an extra layer of protection.
Copy Your API Key
In the same settings panel you will see your unique API Key. Copy it — you'll need it in the next step.
••••••••••••••••••••••••••••••••
Add the API Key in Compass Partner
Open Compass Desktop and navigate to:
Toggle the Obsidian integration on, paste the API key you copied, and click Save.
More Integrations Coming Soon
We're working on guides for additional MCP servers. Stay tuned.