obsidian-notes-rag CLAUDE.md

Repository instructions for a server that searches Obsidian notes by meaning. Obsidian is a note-taking app, and semantic search finds related ideas rather than only exact words.

In plain words
What is it for?
Maintaining the server, refreshing an Obsidian vault index, searching notes, finding similar notes, and retrieving note context.
Why use it?
They explain how to install, index, search, test, and run the note-search server, including its local and hosted processing options.

Instructions file

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/proofsh/obsidian-notes-rag/claude-md
Clone the repo
git clone --depth 1 https://github.com/proofsh/obsidian-notes-rag
Per session 1,233 This file is loaded in full into every session.
When invoked 1,233 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.01233 $0.01233
Opus 5 $0.00616 $0.00616
Sonnet 5 $0.00247 $0.00247
Haiku 4.5 $0.00123 $0.00123

Measured 3d ago against content hash 04f3dcce6ddd, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

obsidian-notes-rag CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 114 lines

How it starts

The opening of the file, as written. The whole thing — 114 lines — stays where its author put it; the contents beside it link to each section on GitHub.

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

obsidian-notes-rag is an MCP (Model Context Protocol) server that provides semantic search over Obsidian notes. It uses OpenAI embeddings by default (or Ollama/LM Studio for local processing) with sqlite-vec for vector storage.

PyPI: https://pypi.org/project/obsidian-notes-rag/ GitHub: https://github.com/proofgeist/obsidian-notes-rag

Commands

# Install dependencies
uv sync --dev

# Run tests
uv run pytest -v

# Type checking
uv run pyright

# Interactive setup wizard
uv run obsidian-rag setup

# Index vault (manual refresh)
uv run obsidian-rag index

# Run the MCP server (stdio transport)
uv run obsidian-rag serve

# Watch vault for changes
uv run obsidian-rag watch

# Search from CLI
uv run obsidian-rag search "query"
obsidian-rag similar "Path/To/Note.md"
obsidian-rag context "Path/To/Note.md"

Architecture

Data Flow

Obsidian Vault → VaultIndexer → Embedder (OpenAI/Ollama/LMStudio) → VectorStore (sqlite-vec)
                                                                          ↓
MCP Client ← MCPServer (mcp 2.x) ← search_notes/get_similar/etc.

Key Components (src/obsidian_rag/)

  • config.py: Config dataclass, load_config()/save_config() for TOML config file, cross-platform paths via platformdirs
  • indexer.py: VaultIndexer scans markdown files, chunk_markdown() uses Chonkie RecursiveChunker with markdown-aware rules, OpenAIEmbedder/OllamaEmbedder/LMStudioEmbedder generate embeddings, create_embedder() factory selects provider
  • store.py: VectorStore wraps sqlite-vec with KNN vector search, two tables (chunks metadata + chunks_vec virtual table), handles upsert/delete by file path. Thread-safe (check_same_thread=False + threading.Lock).
  • server.py: MCPServer (mcp 2.x decorator API, successor to FastMCP) exposing 5 tools: search_notes, get_similar, get_note_context, get_stats, reindex
  • watcher.py: VaultWatcher uses watchdog with debouncing (default 2s) to incrementally re-index on file changes
  • cli.py: Click-based CLI with setup wizard, --provider option, commands for indexing, searching, similar, context, watching, and service management

Read the full file on GitHub · 114 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 114 lines · 1,233 tokens per session scan A 04f3dcce6ddd

Subscribe to this mod's changes

obsidian-notes-rag CLAUDE.md is an instructions file published in the GitHub repository proofsh/obsidian-notes-rag (15 stars, last pushed 6d ago), licensed MIT. It adds 1,233 tokens to every session, about $0.0062 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

GPT-RAG config-python.instructions.md

Instructions for Azure/GPT-RAG, a project described as: Sharing the learning along the way we been gathering to enable Azure OpenAI at enterprise scale in a secure manner. GPT-RAG core is a Retrieval-Augmented Generation pattern running in Azure, using Azure Cognitive Search for retrieval and Azure OpenAI large…

Azure/GPT-RAG · 180 tokens

GPT-RAG release.instructions.md

Instructions for Azure/GPT-RAG, a project described as: Sharing the learning along the way we been gathering to enable Azure OpenAI at enterprise scale in a secure manner. GPT-RAG core is a Retrieval-Augmented Generation pattern running in Azure, using Azure Cognitive Search for retrieval and Azure OpenAI large…

Azure/GPT-RAG · 207 tokens

pdf-brain AGENTS.md

Instructions for joelhooks/pdf-brain, covering pdf-brain agent notes, libsql quirks, ai sdk pattern, key files and docs.

joelhooks/pdf-brain · 531 tokens

rag-code-mcp copilot-instructions.md

Instructions for doITmagic/rag-code-mcp, covering copilot instructions - ragcode mcp, ⚖️ the golden rule, project overview, architecture & patterns and developer workflows.

doITmagic/rag-code-mcp · 568 tokens

gpt-rag-mcp AGENTS.md

Instructions for Azure/gpt-rag-mcp, covering gpt-rag mcp engineering-agent contract, priority, what this repository is, repository boundaries and how to work.

Azure/gpt-rag-mcp · 1,862 tokens

gemini-cli-extension GEMINI.md

Instructions for pinecone-io/gemini-cli-extension, covering pinecone extension for gemini cli, available agent skills, key concepts & setup and available mcp tools.

pinecone-io/gemini-cli-extension · 569 tokens