Skip to main content

Semantic search for Obsidian vaults via MCP

Project description

Obsidian RAG MCP Server

Your notes, searchable by meaning.

An MCP server that gives Claude Code semantic search over your Obsidian vault. Ask questions in natural language, get answers from your own documents.

CI Python 3.11+ License: MIT MCP


The Problem

You have 500 notes in Obsidian. You know you wrote something about database timeouts causing customer issues... somewhere. Ctrl+F won't help when you don't remember the exact words.

The Solution

This server indexes your vault with vector embeddings. Ask for "RCAs where database timeouts caused customer-facing issues" and get results even if your notes use terms like "CosmosDB latency", "connection pool exhaustion", or "query timeout."

Semantic search. Vectors stored locally. Sub-second queries.


Quick Start

# Clone and install (using uv - recommended)
git clone https://github.com/danielscholl/obsidian-rag-mcp.git
cd obsidian-rag-mcp
uv sync

# Set your API key
export OPENAI_API_KEY="sk-..."

# Index the sample vault (or your own)
uv run obsidian-rag index --vault ./vault

# Search it
uv run obsidian-rag search "database connection issues" --vault ./vault
Output
Query: database connection issues
Found 3 results (searched 1154 chunks)

--- Result 1 (score: 0.480) ---
Source: RCAs/2025-05-17-database-connection-pool-exhaustion.md
Tags: database, p1, rca

# 2025-05-17 - Database Connection Pool Exhaustion in payment-gateway...

--- Result 2 (score: 0.466) ---
Source: RCAs/2025-06-18-database-connection-pool-exhaustion.md
Tags: database, p2, rca

# 2025-06-18 - Database Connection Pool Exhaustion in auth-service...

Connect to Claude Code

Add to ~/.claude/claude_desktop_config.json:

{
  "mcpServers": {
    "obsidian-rag": {
      "command": "uv",
      "args": ["run", "--directory", "/path/to/obsidian-rag-mcp", "obsidian-rag", "serve"],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/vault",
        "OPENAI_API_KEY": "sk-..."
      }
    }
  }
}

Then ask Claude things like:

  • "Search my vault for notes about Kubernetes deployments"
  • "Find RCAs related to authentication failures"
  • "What did I write about the Q3 migration?"

MCP Tools

Tool What it does
search_vault Semantic search across all content
search_by_tag Filter by Obsidian tags
get_note Retrieve full note content
get_related Find notes similar to a given note
list_recent Recently modified notes
index_status Index statistics
search_with_reasoning Search with extracted conclusions
get_conclusion_trace Trace reasoning for a conclusion
explore_connected_conclusions Find related conclusions

How It Works

  1. Index: Scans your vault, chunks markdown intelligently (respecting headers, code blocks), generates embeddings via OpenAI
  2. Store: Vectors go into ChromaDB (local, no external database needed)
  3. Query: Your question gets embedded, matched against stored vectors, ranked results returned
  4. Reasoning (optional): Extract conclusions from notes at index time for richer search results

Documentation:


Configuration

Variable Required Description
OPENAI_API_KEY Yes* For embeddings (and reasoning if enabled)
AZURE_OPENAI_ENDPOINT No* Azure OpenAI endpoint URL
AZURE_API_KEY No* Azure OpenAI API key
AZURE_OPENAI_VERSION No Azure API version (default: 2024-10-21)
AZURE_EMBEDDING_DEPLOYMENT No Azure deployment name (default: text-embedding-3-small)
OBSIDIAN_VAULT_PATH No Default vault path
REASONING_ENABLED No Enable conclusion extraction (default: false)

* Either OPENAI_API_KEY or AZURE_OPENAI_ENDPOINT + AZURE_API_KEY is required. When both Azure variables are set, Azure OpenAI is used automatically.

Cost: ~$0.02 to index 100 notes. Queries are essentially free.


Development

uv sync

# Tests
uv run pytest

# Lint + format
uv run black obsidian_rag_mcp/ tests/
uv run ruff check obsidian_rag_mcp/ tests/

See docs/DEVELOPMENT.md for the full guide.


Requirements

  • Python 3.11+
  • OpenAI API key
  • An Obsidian vault (or use vault/ for testing)

License

MIT


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obsidian_rag_mcp-0.2.0.tar.gz (264.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

obsidian_rag_mcp-0.2.0-py3-none-any.whl (39.8 kB view details)

Uploaded Python 3

File details

Details for the file obsidian_rag_mcp-0.2.0.tar.gz.

File metadata

  • Download URL: obsidian_rag_mcp-0.2.0.tar.gz
  • Upload date:
  • Size: 264.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for obsidian_rag_mcp-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a3cbbac7f02da7a1c55b5fdc63b55c3596b4dd60a138db8473ee27a00a3cfd03
MD5 c12aa110d8753f718de1439d94a82461
BLAKE2b-256 425e5680a021093e93cfc580a1dfaf05b90f81fdc3be9505c6ef99149ccd62fc

See more details on using hashes here.

Provenance

The following attestation bundles were made for obsidian_rag_mcp-0.2.0.tar.gz:

Publisher: release.yml on danielscholl/obsidian-rag-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file obsidian_rag_mcp-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for obsidian_rag_mcp-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8f4e981e9cfc2da5b3eb1f2a6ab54bebf9c25b2c4b4b860693644540f0162cb5
MD5 80097d56bdfaefce7384ba65d0e4997c
BLAKE2b-256 eefb9d8cfc0febbb782352722788b64978d9ecb07af002264e85d72c09e3c68e

See more details on using hashes here.

Provenance

The following attestation bundles were made for obsidian_rag_mcp-0.2.0-py3-none-any.whl:

Publisher: release.yml on danielscholl/obsidian-rag-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page