obsidian-rag CLAUDE.md

obsidian-rag CLAUDE.md is an instructions file for coding agents from thoreinstein/obsidian-rag. It costs 677 tokens per session, scanned A, original, MIT.

Project instructions for obsidian-rag, a Claude Code plugin that connects an Obsidian note vault to a local search system. They describe its design, build process, file paths, and dependency rules.

In plain words
What is it for?
Use them when developing, building, or debugging obsidian-rag, especially its MCP tools, note indexing, vector storage, and embedding setup.
Why use it?
They give coding agents the project context and constraints needed to change or build obsidian-rag without breaking its local search or native dependencies.

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/thoreinstein/obsidian-rag/claude-md
Clone the repo
git clone --depth 1 https://github.com/thoreinstein/obsidian-rag

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for obsidian-rag CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/thoreinstein/obsidian-rag/claude-md.svg)](https://agentmods.dev/instructions/thoreinstein/obsidian-rag/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/thoreinstein/obsidian-rag/claude-md"><img src="https://agentmods.dev/badge/instructions/thoreinstein/obsidian-rag/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 677 This file is loaded in full into every session.
When invoked 677 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.00677 $0.00677
Opus 5 $0.00338 $0.00338
Sonnet 5 $0.00135 $0.00135
Haiku 4.5 $0.00068 $0.00068

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

Security

Grade A, and why

obsidian-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 4d 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 · 52 lines

How it starts

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

obsidian-rag

Claude Code plugin providing Obsidian vault integration with local RAG (Retrieval Augmented Generation).

Architecture

  • MCP Server (src/index.ts): Exposes 16 tools via the Model Context Protocol over stdio. Also supports one-shot CLI mode for hook scripts.
  • Embedder (src/rag/embedder.ts): Local embedding via @xenova/transformers (all-MiniLM-L6-v2). Singleton pattern.
  • Vector Store (src/rag/store.ts): LanceDB-backed vector store with incremental indexing and md5-based change detection.

Build

npm install
npm run build

The build uses esbuild to bundle into dist/index.js (committed to the repo). Native dependencies (@lancedb/lancedb, onnxruntime-node, sharp) are externalized.

Key Constraints

  • onnxruntime-node pinned to 1.14.0: Required by @xenova/transformers 2.17.x. Do not upgrade.
  • Native deps externalized: The esbuild bundle excludes @lancedb/lancedb, onnxruntime-node, and sharp — they load from node_modules at runtime.
  • sharp is required: Transitive runtime dependency of @xenova/transformers (imported at top-level in utils/image.js). Must stay in dependencies since esbuild externalizes it.
  • Dependency placement is intentional: Bundled deps (MCP SDK, transformers, glob, gray-matter, md5) are in devDependencies because esbuild bakes them into dist/index.js. Externalized native deps are in dependencies because they load from node_modules at runtime.
  • dist/ is committed: The built artifact is checked in so the plugin works without a build step after clone + npm install.

Data Paths

When running as an installed plugin, all state is stored in ${CLAUDE_PLUGIN_DATA}/ (persistent across plugin updates). Falls back to ~/ for development/CLI usage.

  • Config: .obsidian-rag.config.json
  • LanceDB: .obsidian-rag-lancedb/
  • File hashes: .obsidian-rag-file-hashes.json

Environment Variables

  • OBSIDIAN_VAULT_PATH: Default vault path (overrides config file)
  • OBSIDIAN_RAG_MIN_CHUNK_CHARS: Minimum chunk size (default 40)
  • OBSIDIAN_RAG_MAX_CHUNK_CHARS: Maximum chunk size (default 1800)
  • OBSIDIAN_RAG_TARGET_CHUNK_CHARS: Target chunk size for merging (default 700)
  • OBSIDIAN_RAG_EMBED_BATCH_SIZE: Embedding batch size (default 48)

Read the full file on GitHub · 52 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. 4d ago First seen · 52 lines · 677 tokens per session scan A dbd382929f91

Subscribe to this mod's changes

obsidian-rag CLAUDE.md is an instructions file published in the GitHub repository thoreinstein/obsidian-rag (2 stars, last pushed 1mo ago), licensed MIT. It adds 677 tokens to every session, about $0.0034 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-31.