agentmods.dev

obsidian-mcp: Instructions file for Claude Code

CLAUDE.md

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

A set of project instructions for working on an Obsidian vault service: a self-hosted program that exposes notes through a standard tool interface.

In plain words
What is it for?
Use it when developing, testing, building, or documenting the jclement/obsidian-mcp repository.
Why use it?
It explains the project's commands, structure, technology choices, and coding rules so changes fit the existing system and can be checked before committing.

Instructions file for Claude Code

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

This is jclement/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 3repo +1 4mo ago A scan 1,607 tokens original MIT
View source ↗ jclement/obsidian-mcp
Reuse

Borrowing it

Nothing to install: this file belongs to jclement/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/jclement/obsidian-mcp/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/jclement/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/jclement/obsidian-mcp/claude-md/github.svg)](https://agentmods.dev/instructions/jclement/obsidian-mcp/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/jclement/obsidian-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/jclement/obsidian-mcp/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for obsidian-mcp CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/jclement/obsidian-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/jclement/obsidian-mcp/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,607 This file is loaded in full into every session.
When invoked 1,607 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.01607 $0.01607
Opus 5.5 $0.00643 $0.00643
Sonnet 5.5 $0.00321 $0.00321
Haiku 4.5 $0.00161 $0.00161

Measured 2mo ago against content hash 456d7604d8cf, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 2mo 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 · 63 lines

How it starts

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

CLAUDE.md

Guidance for working in this repo. Read this before making changes.

What this is

A self-hosted single-container service exposing an Obsidian vault over MCP, with a passkey-protected management UI, OAuth 2.1 + bearer auth, optional Obsidian Sync, and automatic git snapshots. Runtime is Bun + TypeScript + Hono; UI is server-rendered Hono JSX + HTMX + Tailwind v4; state is bun:sqlite.

Commands

Use mise tasks (they pin the toolchain):

Task What
mise run dev Server with hot reload + Tailwind watch → http://localhost:3000
mise run test Full bun test suite
mise run typecheck tsc --noEmit
mise run build Minify CSS + bundle server to dist/
mise run docker:build Build the container image

Direct equivalents: bun test, bun test test/vault.test.ts (single file), bun test -t "name" (by test name), bunx tsc --noEmit.

Always run bunx tsc --noEmit and bun test before committing. The suite is ~133 tests and ~25s; keep it green.

Architecture (src/)

  • server.ts — boot: config → migrate DB → snapshotter → sync supervisor → Bun.serve; SIGTERM lifecycle. app.tsx — Hono wiring, middleware order, route mounting.
  • config.ts — env parsing. PUBLIC_URL is optional; when unset the public origin/rpID are derived per-request from proxy headers (web/origin.ts).
  • vault/ — the filesystem core. paths.ts (the safePath/safeWritePath chokepoint — all paths go through it), store.ts (atomic writes, per-path mutex, content-hash optimistic concurrency), frontmatter.ts, markdown.ts, links.ts (wikilink resolution + rewrite), search.ts, obsidian-config.ts (reads .obsidian/ settings + moment-format dates).
  • mcp/ — server.ts builds the McpServer; one file per tool in tools/; audit.ts records every call; context.ts is the per-process handle passed to tools.
  • auth/ — webauthn.ts (passkeys, rpID pinning), sessions.ts, tokens.ts (static + OAuth bearer, hashed), middleware.ts (guards, rate limit, origin resolution).
  • oauth/ — hand-rolled OAuth 2.1 AS (DCR, PKCE, refresh rotation).
  • snapshots/ — git snapshots in a bare repo outside the vault (--git-dir/--work-tree), so no .git ever lands in data/Vault.
  • sync/ — ob.ts (isolates the obsidian-headless CLI; it's 0.0.x beta, flags may drift — change them only here), supervisor.ts (process supervision, SIGTERM→SIGKILL), lock.ts (one ob per vault).
  • web/ — layout.tsx, routes/*.tsx (one router per page), origin.ts.
  • db/ — index.ts (open + numbered migrations) and migrations/*.sql.

Read the full file on GitHub · 63 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. 2mo ago First seen · 63 lines · 1,607 tokens per session scan A 456d7604d8cf

Subscribe to this mod's changes

obsidian-mcp CLAUDE.md is an instructions file published in the GitHub repository jclement/obsidian-mcp (3 stars, last pushed 4mo ago), licensed MIT. It adds 1,607 tokens to every session, about $0.0064 per session on Opus 5.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.

Related

obsidian-mcp CLAUDE.md compared with instructions from other repositories

obsidian-mcp CLAUDE.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
obsidian-mcp CLAUDE.mdjclement/obsidian-mcpInstructions file34mo agoMITA1,607Claude Code
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143kyesterdayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode