Allows interaction with an Obsidian vault through the Local REST API plugin, enabling tools for reading, writing, and patching notes, managing periodic notes, executing commands, and performing searches via plain-text, Dataview, or JsonLogic.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@MCP Obsidian ServerSearch for all notes mentioning 'Project Phoenix' and summarize the key action items."
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
MCP server for Obsidian (TypeScript + Bun)
A Model-Context-Protocol (MCP) server that lets Claude (or any MCP-compatible LLM) interact with your Obsidian vault through the Local REST API community plugin – written in TypeScript and runnable with bunx.
✨ Components
Tools
Tool name | Description |
obsidian_status | Returns basic details about the Obsidian Local REST API server and your authentication status |
obsidian_delete_active | Deletes the note that is currently active in the Obsidian UI |
obsidian_get_active | Retrieves the full content of the active note (Markdown or JSON view) |
obsidian_patch_active | Inserts, replaces or prepends content in the active note relative to a heading, block reference, or front-matter field |
obsidian_post_active | Appends Markdown to the end of the active note |
obsidian_put_active | Replaces the entire body of the active note |
obsidian_get_commands | Lists every command available in Obsidian’s command palette |
obsidian_execute_command | Executes a specific Obsidian command by its ID |
obsidian_open_file | Opens the given file inside Obsidian (creates it if missing); optional flag to open in a new leaf |
obsidian_delete_periodic | Deletes the current daily / weekly / monthly / quarterly / yearly note for the requested period |
obsidian_get_periodic | Returns the content of the current periodic note for the requested period |
obsidian_patch_periodic | Inserts / replaces content in a periodic note relative to a heading, block reference, or front-matter field |
obsidian_post_periodic | Appends Markdown to the periodic note (creates it if it doesn’t exist) |
obsidian_put_periodic | Replaces the entire body of a periodic note |
obsidian_search_dataview | Runs a Dataview-DQL query across the vault and returns matching rows |
obsidian_search_json_logic | Runs a JsonLogic query against structured note metadata |
obsidian_simple_search | Performs a plain-text fuzzy search with optional surrounding context |
obsidian_list_vault_root | Lists all files and directories at the root of your vault |
obsidian_list_vault_directory | Lists files and directories inside a specific folder of the vault |
obsidian_delete_file | Deletes a specific file (or directory) in the vault |
obsidian_get_file | Retrieves the content of a file in the vault (Markdown or JSON view) |
obsidian_patch_file | Inserts / replaces content in an arbitrary file relative to a heading, block reference, or front-matter field |
obsidian_post_file | Appends Markdown to a file (creates it if it doesn’t exist) |
obsidian_put_file | Creates a new file or replaces the entire body of an existing file |
See Obsidian's
Example prompts
⚙️ Configuration
Obsidian REST API key
There are two ways to pass the Obsidian API key to the server:
Server config (recommended) – pass it via the
envfield in your Claude (or other client) MCP-server declaration:
Use@fazer-ai/mcp-obsidian@latest to ensure you always run the most up to date version of the server.
Alternatively, you can use an
.env. Place the key in the.envyou created above. Note it must be placed in the working directory where the MCP server is running.
Environment variables
You can use the .env.example file as reference to create your own .env file.
🛠 Development
Running local version on Claude Desktop
After cloning this repo, you can update Claude's config to run your local version of the server instead of pulling from npm. This is useful for quickly testing changes before publishing.
Keep in mind any changes you make on the code will only take effect after restarting the Claude Desktop app.
Clone this repo and run
bun installto install dependencies.Update your
claude_desktop_config.jsonto point to your local version of the server:
Note we usebun instead of bunx here.
Debugging
MCP servers talk over stdio, so normal debuggers aren’t helpful.
Use the MCP Inspector:
Open the URL it prints to step through requests (usually http://localhost:6274), inspect tool calls, and watch logs in real time.
📦 Publishing
Update the version in
package.json.Create GitHub release.
Run
bun publish.
License
MIT – see LICENSE.