Obsidian Self MCP Server

Local setup required. This server has to be cloned and prepared on your machine before you register it in Claude Code.
1

Set the server up locally

Run this once to clone and prepare the server before adding it to Claude Code.

Run in terminal
pip install obsidian-self-mcp
2

Register it in Claude Code

After the local setup is done, run this command to point Claude Code at the built server.

Run in terminal
claude mcp add -e "OBSIDIAN_COUCH_URL=${OBSIDIAN_COUCH_URL}" -e "OBSIDIAN_COUCH_USER=${OBSIDIAN_COUCH_USER}" -e "OBSIDIAN_COUCH_PASS=${OBSIDIAN_COUCH_PASS}" obsidian-self-mcp -- node "<FULL_PATH_TO_OBSIDIAN_SELF_MCP>/dist/index.js"

Replace <FULL_PATH_TO_OBSIDIAN_SELF_MCP>/dist/index.js with the actual folder you prepared in step 1.

Required:OBSIDIAN_COUCH_URLOBSIDIAN_COUCH_USEROBSIDIAN_COUCH_PASS+ 1 optional
README.md

Direct programmatic access to Obsidian vaults through CouchDB

obsidian-self-mcp

An MCP server and CLI that gives you direct access to your Obsidian vault through CouchDB — the same database that Obsidian LiveSync uses to sync your notes.

No Obsidian app required. Works on headless servers, in CI pipelines, from AI agents, or anywhere you can run Python.

How it works

If you use Obsidian LiveSync, your vault is already stored in CouchDB. This tool talks directly to that CouchDB instance — reading, writing, searching, and managing notes using the same document/chunk format that LiveSync uses. Changes sync back to Obsidian automatically.

Who this is for

  • Self-hosted LiveSync users who want programmatic vault access
  • Homelab operators running headless servers with no GUI
  • AI agent builders who need to give Claude, GPT, or other agents access to an Obsidian vault via MCP
  • Automation pipelines that read/write notes (changelogs, daily notes, project docs)

How this differs from Obsidian's official CLI

Obsidian has an official CLI that requires the Obsidian desktop app running locally and a Catalyst license. This project requires neither — just a CouchDB instance with LiveSync data.

Feature Official CLI obsidian-self-mcp
Requires Obsidian app Yes (must be running) No
Requires Catalyst license Yes ($25+) No (MIT, free)
Read/write notes Yes Yes
Search Yes Yes
Frontmatter/properties Yes Yes
Tags Yes Yes
Backlinks Yes (via app index) Yes (content scanning)
Templates Yes No (planned)
Canvas Yes No
Graph view No No
Works headless/CI No Yes
MCP server No Yes
Transport Local REST API CouchDB (network)

Requirements

  • Python 3.10+
  • A CouchDB instance with Obsidian LiveSync data
  • The database name, URL, and credentials

Installation

pip install obsidian-self-mcp

Or install from source:

git clone https://github.com/suhasvemuri/obsidian-self-mcp.git
cd obsidian-self-mcp
pip install -e .

Configuration

Set these environment variables:

export OBSIDIAN_COUCH_URL="http://your-couchdb-host:5984"
export OBSIDIAN_COUCH_USER="your-username"
export OBSIDIAN_COUCH_PASS="your-password"
export OBSIDIAN_COUCH_DB="obsidian-vault"    # optional, defaults to "obsidian-vault"

MCP Server Setup

Claude Desktop

Add to your Claude Desktop config (~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "obsidian-self-mcp": {
      "command": "python",
      "args": ["-m", "obsidian_self_mcp.server"],
      "env": {
        "OBSIDIAN_COUCH_URL": "http://your-couchdb-host:5984",
        "OBSIDIAN_COUCH_USER": "your-username",
        "OBSIDIAN_COUCH_PASS": "your-password",
        "OBSIDIAN_COUCH_DB": "obsidian-vault"
      }
    }
  }
}

Claude Code

Add to your Claude Code settings (.claude/settings.json or global):

{
  "mcpServers": {
    "obsidian-self-mcp": {
      "command": "python",
      "args": ["-m", "obsidian_self_mcp.server"],
      "env": {
        "OBSIDIAN_COUCH_URL": "http://your-couchdb-host:5984",
        "OBSIDIAN_COUCH_USER": "your-username",
        "OBSIDIAN_COUCH_PASS": "your-password",
        "OBSIDIAN_COUCH_DB": "obsidian-vault"
      }
    }
  }
}

Available MCP Tools

Tool Description
list_notes List notes with metadata, optionally filtered by folder
read_note Read the full content of a note
write_note Create or update a note
search_notes Search note content (case-insensitive)
append_note Append content to an existing note
delete_note Delete a note and its chunks
list_folders List all folders with note counts
read_frontmatter Read frontmatter properties from a note
update_frontmatter Set/update frontmatter properties (JSON input)
list_tags List all tags in the vault with counts
search_by_tag Find notes containing a specific tag
get_backlinks Find notes that link to a given note
get_outbound_links List wikilinks from a note

CLI Usage

The obsidian command provides the same operations from the terminal:

# List notes
obsidian list
obsidian list "Dev Projects" -n 10
obsidian ls                              # alias

# Read a note
obsidian read "Notes/todo.md"
obsidian cat "Notes/todo.md"             # alias

# Write a note
obsidian write "Notes/new.md" "# Hello"
obsidian write "Notes/new.md" -f local-file.md
echo "content" | obsidian write "Notes/new.md"

# Search
obsidian search "kubernetes" -d "Dev Projects" -n 5
obsidian grep "kubernetes"               # alias

# Append to a note
obsidian append "Notes/log.md" "New entry"

# Delete a note
obsidian delete "Notes/old.

Tools (13)

list_notesList notes with metadata, optionally filtered by folder
read_noteRead the full content of a note
write_noteCreate or update a note
search_notesSearch note content (case-insensitive)
append_noteAppend content to an existing note
delete_noteDelete a note and its chunks
list_foldersList all folders with note counts
read_frontmatterRead frontmatter properties from a note
update_frontmatterSet/update frontmatter properties (JSON input)
list_tagsList all tags in the vault with counts
search_by_tagFind notes containing a specific tag
get_backlinksFind notes that link to a given note
get_outbound_linksList wikilinks from a note

Environment Variables

OBSIDIAN_COUCH_URLrequiredThe URL of your CouchDB instance
OBSIDIAN_COUCH_USERrequiredUsername for CouchDB authentication
OBSIDIAN_COUCH_PASSrequiredPassword for CouchDB authentication
OBSIDIAN_COUCH_DBThe database name (defaults to obsidian-vault)

Configuration

claude_desktop_config.json
{"mcpServers": {"obsidian-self-mcp": {"command": "python", "args": ["-m", "obsidian_self_mcp.server"], "env": {"OBSIDIAN_COUCH_URL": "http://your-couchdb-host:5984", "OBSIDIAN_COUCH_USER": "your-username", "OBSIDIAN_COUCH_PASS": "your-password", "OBSIDIAN_COUCH_DB": "obsidian-vault"}}}}

Try it

Search my vault for notes related to 'kubernetes' and summarize the findings.
List all notes in the 'Projects' folder and tell me which ones have the 'todo' tag.
Read the frontmatter of 'Daily Notes/2023-10-27.md' and append a new task to the bottom.
Find all notes that link to 'Project Alpha' to see what is currently referencing it.

Frequently Asked Questions

What are the key features of Obsidian Self MCP?

Direct read/write access to Obsidian vaults via CouchDB. Headless operation without requiring the Obsidian desktop app. Full support for frontmatter, tags, and wikilink scanning. Compatible with CI pipelines and automated note management. MIT licensed and free to use without a Catalyst license.

What can I use Obsidian Self MCP for?

Automating daily note creation or changelog updates in CI pipelines. Enabling AI agents to read and update personal knowledge bases. Managing Obsidian vaults on headless servers or homelab environments. Programmatically querying vault metadata for project tracking.

How do I install Obsidian Self MCP?

Install Obsidian Self MCP by running: pip install obsidian-self-mcp

What MCP clients work with Obsidian Self MCP?

Obsidian Self MCP works with any MCP-compatible client including Claude Desktop, Claude Code, Cursor, and other editors with MCP support.

Turn this server into reusable context

Keep Obsidian Self MCP docs, env vars, and workflow notes in Conare so your agent carries them across sessions.

Need the old visual installer? Open Conare IDE.
Open Conare