agentmods.dev

obsidian-mcp: Instructions file for Claude Code

CLAUDE.md

obsidian-mcp CLAUDE.md is an instructions file for Claude Code from maxkuminov/obsidian-mcp. It costs 3,604 tokens per session, scanned A, original, MIT.

Project instructions for an Obsidian MCP server that exposes a large collection of Obsidian notes through semantic search, full-text search, and guided exploration.

In plain words
What is it for?
Use them when developing, configuring, or maintaining this self-hosted Obsidian note-search server.
Why use it?
They explain the server's technology, layout, database, search, and embedding setup so an agent can work on the project with the right context.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: reads .claude/ paths; mentions subagents; mentions Codex.

This is maxkuminov/obsidian-mcp's own configuration. It tells Claude Code how to work on obsidian-mcp itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything obsidian-mcp configures →

not rated 12repo +1 changed today A scan 3,604 tokens original MIT
View source ↗ maxkuminov/obsidian-mcp
Reuse

Borrowing it

Nothing to install: this file belongs to maxkuminov/obsidian-mcp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/maxkuminov/obsidian-mcp/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/maxkuminov/obsidian-mcp

Made for: Claude Code.

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-mcp CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/maxkuminov/obsidian-mcp/claude-md.svg)](https://agentmods.dev/instructions/maxkuminov/obsidian-mcp/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/maxkuminov/obsidian-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/maxkuminov/obsidian-mcp/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 3,604 This file is loaded in full into every session.
When invoked 3,604 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.03604 $0.03604
Opus 5 $0.01802 $0.01802
Sonnet 5 $0.00721 $0.00721
Haiku 4.5 $0.00360 $0.00360

Measured today against content hash 89e68212b8c2, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

obsidian-mcp 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 today.

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 · 224 lines

How it starts

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

Obsidian MCP Server

Self-hosted MCP server exposing an Obsidian vault (~2,577 markdown files) via semantic search, full-text search, and agentic exploration.

Stack

  • Python 3.12 / FastAPI / uvicorn
  • SQLAlchemy async + asyncpg + pgvector
  • MCP Python SDK (Streamable HTTP)
  • PostgreSQL 16 with pgvector (shared instance — see .env)
  • Embedding provider abstraction (src/services/embeddings.py):
    • OllamaProvider — bge-m3 by default, set OLLAMA_URL in .env
    • OpenAIProvider — text-embedding-3-{small,large} over httpx, supports Azure OpenAI / OpenAI-compatible base URLs
  • Jinja2 control panel; htmx and Chart.js vendored under src/control_panel/static/vendor/, no CDN, hand-written CSS, no CSP — see control panel for why.

Project Layout

  • src/main.py — FastAPI app, lifespan, MCP mount
  • src/config.py — pydantic-settings
  • src/database.py — async SQLAlchemy engine/session
  • src/models/db.py — ORM models (api_keys, usage_logs, notes_metadata, note_embeddings, note_links, indexer_runs, transfer_tokens, oauth_clients/codes/tokens)
  • src/mcp_server/ — MCP server, tools, auth middleware
  • src/services/ — vault ops, search, embeddings, indexer, transfer, anchored FS
  • src/transfer/ — public /transfer/* capability-redemption routes
  • src/api/ — control panel REST endpoints
  • src/control_panel/ — Jinja2 templates + static assets
  • alembic/ — database migrations

Infrastructure

  • Container: obsidian-mcp, listens on :8000
  • Traefik routes: hostname driven by MCP_HOSTNAME in .env
    • Panel routes: OAuth protected via chain-oauth@file
    • MCP routes (/mcp/*): API key auth at app level
    • Transfer routes (/transfer/*): same router as /mcp (no OAuth chain); capability-token auth at app level
  • Registry: localhost:5000 (or change in Makefile)
  • Deploy: make deploy (build → scan → push → backup → migrate → recreate)

Public repo — host paths live outside the tree

This repo is published on GitHub. Anything host-specific (paths, secrets, hostnames) must stay out of tracked files. The mechanism:

  • Makefile.local (gitignored) overrides DEPLOY_DIR and DATA_DIR. On the production host both point at /storage/docker/data/obsidian-mcp/, which holds the real docker-compose.yml, .env, and backups/.
  • The compose project that owns the running container is rooted at $(DEPLOY_DIR), not the repo. Always invoke make from the repo so Makefile.local loads — cd /storage/docker/data/obsidian-mcp && docker compose ... works but skips the build/push pipeline.
  • The repo's docker-compose.yml and the deploy-dir copy are kept identical; if you change one, copy it over.

Read the full file on GitHub · 224 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. today Changed · +45 lines · +938 tokens per session 89e68212b8c2
  2. 6d ago First seen · 179 lines · 2,666 tokens per session scan A c77a1fa6ba47

Subscribe to this mod's changes

obsidian-mcp CLAUDE.md is an instructions file published in the GitHub repository maxkuminov/obsidian-mcp (12 stars, last pushed today), licensed MIT. It adds 3,604 tokens to every session, about $0.0180 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.

Memory and contextResearch
Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens