mcp-obsidian

MCP.Pizza Chef: MarkusPfundstein

The mcp-obsidian server is an MCP server designed to integrate with Obsidian note-taking software through the Obsidian Local REST API community plugin. It provides a suite of tools that allow models to interact programmatically with an Obsidian vault, including listing files and directories, retrieving file contents, searching notes, and modifying content by patching, appending, or deleting files. This server enables advanced automation and AI-assisted workflows within Obsidian, making it easier to manage and manipulate notes and documents in real time.

Use This MCP server To

List files and directories in Obsidian vaults Retrieve contents of specific Obsidian notes Search for text across all Obsidian documents Insert or patch content in existing notes Append new content to notes or create new files Delete files or directories from the vault

README

MCP server for Obsidian

MCP server to interact with Obsidian via the Local REST API community plugin.

server for Obsidian MCP server

Components

Tools

The server implements multiple tools to interact with Obsidian:

  • list_files_in_vault: Lists all files and directories in the root directory of your Obsidian vault
  • list_files_in_dir: Lists all files and directories in a specific Obsidian directory
  • get_file_contents: Return the content of a single file in your vault.
  • search: Search for documents matching a specified text query across all files in the vault
  • patch_content: Insert content into an existing note relative to a heading, block reference, or frontmatter field.
  • append_content: Append content to a new or existing file in the vault.
  • delete_file: Delete a file or directory from your vault.

Example prompts

Its good to first instruct Claude to use Obsidian. Then it will always call the tool.

The use prompts like this:

  • Get the contents of the last architecture call note and summarize them
  • Search for all files where Azure CosmosDb is mentioned and quickly explain to me the context in which it is mentioned
  • Summarize the last meeting notes and put them into a new note 'summary meeting.md'. Add an introduction so that I can send it via email.

Configuration

Obsidian REST API Key

There are two ways to configure the environment with the Obsidian REST API Key.

  1. Add to server config (preferred)
{
  "mcp-obsidian": {
    "command": "uvx",
    "args": [
      "mcp-obsidian"
    ],
    "env": {
      "OBSIDIAN_API_KEY": "<your_api_key_here>",
      "OBSIDIAN_HOST": "<your_obsidian_host>"
    }
  }
}
  1. Create a .env file in the working directory with the following required variable:
OBSIDIAN_API_KEY=your_api_key_here
OBSIDIAN_HOST=your_obsidian_host

Note: You can find the key in the Obsidian plugin config.

Quickstart

Install

Obsidian REST API

You need the Obsidian REST API community plugin running: https://github.com/coddingtonbear/obsidian-local-rest-api

Install and enable it in the settings and copy the api key.

Claude Desktop

On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json

On Windows: %APPDATA%/Claude/claude_desktop_config.json

Development/Unpublished Servers Configuration
{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uv",
      "args": [
        "--directory",
        "<dir_to>/mcp-obsidian",
        "run",
        "mcp-obsidian"
      ]
    }
  }
}
Published Servers Configuration
{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uvx",
      "args": [
        "mcp-obsidian"
      ],
      "env": {
        "OBSIDIAN_API_KEY" : "<YOUR_OBSIDIAN_API_KEY>"
      }
    }
  }
}

Development

Building

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-obsidian run mcp-obsidian

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

You can also watch the server logs with this command:

tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-obsidian.log

mcp-obsidian FAQ

How do I set up the mcp-obsidian server?
Install the Obsidian Local REST API community plugin in your Obsidian vault, then configure the mcp-obsidian server to connect to the plugin's REST endpoint.
Can mcp-obsidian modify existing notes?
Yes, it supports patching content relative to headings, block references, or frontmatter fields, as well as appending new content.
Is it possible to search notes using mcp-obsidian?
Yes, the server provides a search tool to find documents matching specified text queries across the entire vault.
How does mcp-obsidian handle file deletions?
It includes a delete_file tool that can remove files or directories from your Obsidian vault safely.
Does mcp-obsidian support nested directories?
Yes, it can list files and directories both at the root and within specific subdirectories of your vault.
What security considerations are there when using mcp-obsidian?
Since it interacts with your local Obsidian vault via REST API, ensure the API plugin is secured and access is controlled to prevent unauthorized modifications.
Can mcp-obsidian be used with different LLM providers?
Yes, it is provider-agnostic and works with models from OpenAI, Anthropic Claude, and Google Gemini, among others.
How do I update content in a note at a specific location?
Use the patch_content tool to insert or modify content relative to a heading, block reference, or frontmatter field within the note.