Skip to main content

Obsidian Vault RAG

Python 3.10+ License: MIT MCP Compatible CI Code style: ruff PyPI version Downloads

Obsidian Vault RAG allows you to import your Obsidian markdown vault into a local LanceDB vector database and expose it via the Model Context Protocol (MCP) for AI agents like Claude.

Features

  • Local RAG: No data leaves your machine; embeddings are stored locally in LanceDB.
  • Smart Ingestion: Splits notes into chunks and generates embeddings.
  • PDF Support: Converts research papers and PDFs to Markdown using Docling.
  • Claude Integration: Connect your vault directly to Claude Desktop.

Installation

Clone the repository and install the package:

# Using pip
pip install -e .

# OR using uv (recommended for speed)
uv pip install .

Quick Start

  1. Configure: Run the setup wizard to link your vault.
    obsidian config
    
  2. Ingest: Index your notes into the database.
    obsidian lance
    
  3. Serve: Start the MCP server (or connect Claude, see below).
    obsidian serve
    

Manual File Creation

To manually add files to your vault, you can use an Obsidian Template to automatically insert the required metadata.

Create a template file in your Obsidian templates folder with the following content:

---
id: {{date:YYYYMMDDHHmm}}
title: {{title}}
authors: []
type: note
status: active
created: {{date:YYYY-MM-DD}}
tags: []
source: "personal"
---

# {{title}}

Your content here...

Documentation

  • Usage Guide: Detailed commands for ingestion, PDF conversion, and serving.
  • Configuration: Settings, environment variables, and logging.

Connect to Claude Desktop

To chat with your notes in Claude Desktop, add the server to your configuration file:

  • Mac: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json

Add the following entry (replace /path/to/your/python with your actual Python executable path):

{
  "mcpServers": {
    "obsidian-vault": {
      "command": "/absolute/path/to/project/.venv/bin/python3",
      "args": [
        "-m",
        "obsidian.cli",
        "serve"
      ]
    }
  }
}

Tip: You can find your python path by running which python (Mac/Linux) or where python (Windows) inside your project environment.

License

MIT

Metadata

Release files for obsidian-vault-rag 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for obsidian-vault-rag 0.1.0
File Size Uploaded
obsidian_vault_rag-0.1.0.tar.gz 3.1 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for obsidian-vault-rag 0.1.0
File Interpreter ABI Platform
obsidian_vault_rag-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 3.1 MB

Release files / obsidian_vault_rag-0.1.0.tar.gz

Download URL obsidian_vault_rag-0.1.0.tar.gz
Size 3.1 MB
Tags Source
SHA-256 checksum
How to use checksums
ce06b087f40a79ae8ac7f85197e973c047ca28640d73a9785f0ae04ac7f9731d
BLAKE2b-256 checksum
How to use checksums
4b1f081d9ccaa50d280763e76392768a22f802b9cc7629444971b1ad381a48c3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"openSUSE Tumbleweed","version":"20260128","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / obsidian_vault_rag-0.1.0-py3-none-any.whl

Download URL obsidian_vault_rag-0.1.0-py3-none-any.whl
Size 31.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
48d1f171201d1a8f8cc4373dd6810b35fd09bd8b876d1ba6fac342ed4387aaf5
BLAKE2b-256 checksum
How to use checksums
24b87893aa442db8c1a886b6cda372761a90503cf246992095f237991bc613cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"openSUSE Tumbleweed","version":"20260128","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page