MCP Obsidian

🚀 MCP Obsidian

A server-side implementation of the Model Context Protocol (MCP) for integrating with Obsidian vaults. This tool enables Claude Desktop (or other MCP clients) to search and read your Obsidian notes.

🚀 Quick Start (User Guide)

Prerequisites

• Node.js 18+ (Install via brew install node)
• An Obsidian vault
• Claude Desktop (Download and install from https://claude.ai/desktop)

Configuration Steps

1. Open your Claude Desktop configuration file located at: ~/Library/Application Support/Claude/claude_desktop_config.json

You can find this file by following these steps:

1. Open Claude Desktop.

2. Click "Claude" in the menu bar.

3. Select "Settings".

4. Click "Developer" again.

5. Add the following content to the configuration file:

{
  "tools": {
    "obsidian": {
      "command": "npx",
      "args": ["-y", "@kazuph/mcp-obsidian"],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/obsidian/vault"
      }
    }
  }
}

Note: Replace /path/to/your/obsidian/vault with the actual path to your Obsidian vault.

🛠️ Developer Guide

Prerequisites

• Node.js 18+ (Install via brew install node)
• An Obsidian vault
• Claude Desktop (Download and install from https://claude.ai/desktop)
• tsx (Install via npm install -g tsx)

📦 Installation

git clone https://github.com/kazuph/mcp-obsidian.git
cd mcp-obsidian
npm install
npm run build

⚙️ Configuration Guide

1. Ensure that Claude Desktop is installed and running.
2. If not already installed, globally install tsx:

npm install -g tsx
# Or use pnpm
pnpm add -g tsx

3. Modify your Claude Desktop configuration file located at: ~/Library/Application Support/Claude/claude_desktop_config.json

Easily find this file by following these steps:

1. Open Claude Desktop.
2. Click "Claude" in the menu bar.
3. Select "Settings".
4. Click "Developer" again.

Add the following content to the configuration file:

{
  "tools": {
    "obsidian": {
      "args": ["tsx", "/path/to/mcp-obsidian/index.ts"],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/obsidian/vault"
      }
    }
  }
}

✨ Available Tools

• obsidian_read_notes: Read the contents of multiple notes. The content of each note will be returned along with its path.
• obsidian_search_notes: Search for notes by name (case-insensitive, supports partial matching and regular expressions).
• obsidian_read_notes_dir: List the directory structure under the specified path.
• obsidian_write_note: Create a new note at the specified path.