mcp-obsidian-via-rest: Instructions file for Claude Code

CLAUDE.md

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

A project instruction file for an MCP server, a program that lets AI assistants use tools and data from other applications, to access Obsidian vaults through Obsidian’s Local REST API plugin. Obsidian is a note-taking application.

In plain words
What is it for?
Use it when building, running, configuring, or debugging the server, including its local standard-input connection, remote HTTP connection, reconnection logic, and Docker setup.
Why use it?
It gives the coding agent the project structure, supported connection methods, setup commands, and development workflow needed to work on the server.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md; positional $N argument; mentions Claude Code.

This is OleksandrKucherenko/mcp-obsidian-via-rest's own configuration. It tells Claude Code how to work on mcp-obsidian-via-rest 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 mcp-obsidian-via-rest configures →

Reuse

Borrowing it

Nothing to install: this file belongs to OleksandrKucherenko/mcp-obsidian-via-rest. 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/OleksandrKucherenko/mcp-obsidian-via-rest/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/OleksandrKucherenko/mcp-obsidian-via-rest

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

README.md
[![agentmods](https://agentmods.dev/badge/instructions/oleksandrkucherenko/mcp-obsidian-via-rest/claude-md/github.svg)](https://agentmods.dev/instructions/oleksandrkucherenko/mcp-obsidian-via-rest/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/oleksandrkucherenko/mcp-obsidian-via-rest/claude-md"><img src="https://agentmods.dev/badge/instructions/oleksandrkucherenko/mcp-obsidian-via-rest/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 mcp-obsidian-via-rest CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/oleksandrkucherenko/mcp-obsidian-via-rest/claude-md"><img src="https://agentmods.dev/badge/instructions/oleksandrkucherenko/mcp-obsidian-via-rest/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 3,822 This file is loaded in full into every session.
When invoked 3,822 The same file — it is already loaded in full.
Security scan A 1 finding. 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.03822 $0.03822
Opus 5 $0.01911 $0.01911
Sonnet 5 $0.00764 $0.00764
Haiku 4.5 $0.00382 $0.00382

Measured 12d ago against content hash 10d40afe1930, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-11, from the pricing page.

Security

Grade A, and why

mcp-obsidian-via-rest CLAUDE.md scanned grade A with 1 finding 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 12d 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

curl http://localhost:3000/health
CLAUDE.md · 472 lines

How it starts

The opening of the file, as written. The whole thing — 472 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

This is an MCP (Model Context Protocol) server that provides access to Obsidian vaults via the Local REST API plugin. The server can run as a standalone Node/Bun application or as a Docker container, enabling AI assistants to read, search, and interact with Obsidian notes.

Multi-Transport Architecture:

  • Transport Manager (src/transports/manager.ts) - Manages lifecycle of multiple transport types
  • MCP Server Factory (src/server/mcp-server.ts) - Creates MCP server instances with tools and resources
  • Transports:
    • stdio - Standard input/output transport (default, best for local MCP clients)
    • http - HTTP JSON-RPC with streaming support (best for remote access)
  • Self-Healing API (src/api/self-healing.ts) - Automatic URL selection and reconnection
  • Configuration System (src/config.ts) - Multi-URL and transport configuration

Development Commands

Building and Running

# Install dependencies
bun install

# Build production bundle
bun run build

# Run locally (development mode with DEBUG logs)
bun run start:dev

# Run locally (production mode)
bun run start

Testing

# Unit tests (src/**/*.test.ts)
bun test ./src

# E2E tests (requires Obsidian REST API running)
bun test:e2e

# Container tests (uses testcontainers)
bun test:containers

Code Quality

# Type checking
bun run checks:types

# Linting (Biome)
bun run checks:lint

# Formatting (Biome)
bun run checks:format

# Unused code detection
bun run checks:knip

Docker Operations

# Build local Docker image
bun run docker:latest

# Run Docker container (requires API_KEY and API_URLS env vars)
bun run docker:run

# Start E2E test environment (dockerized Obsidian)
bun run docker:e2e:start

# Stop E2E test environment
bun run docker:e2e:stop

MCP Inspector (Debugging)

# Debug with local source
bun run mcp:inspector:local

# Debug with Docker container
bun run mcp:inspector:docker

Read the full file on GitHub · 472 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. 12d ago First seen · 472 lines · 3,822 tokens per session scan A 10d40afe1930

Subscribe to this mod's changes

mcp-obsidian-via-rest CLAUDE.md is an instructions file published in the GitHub repository OleksandrKucherenko/mcp-obsidian-via-rest (13 stars, last pushed 5mo ago), licensed MIT. It adds 3,822 tokens to every session, about $0.0191 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). 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

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,153 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

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,126 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

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