obsidian-mcp-ts: Instructions file for Claude Code

CLAUDE.md

obsidian-mcp-ts CLAUDE.md is an instructions file for Claude Code from duquesnay/obsidian-mcp-ts. It costs 5,195 tokens per session, scanned A, original, MIT.

Project instructions for developing obsidian-mcp-ts, a TypeScript MCP server that lets AI assistants work with Obsidian notes through a local REST API plugin. They specify required agent delegation, setup commands, and testing commands.

In plain words
What is it for?
Use them to install dependencies, run development or production builds, and run the project's full or unit test suites.
Why use it?
They provide the repository's expected development process and prevent contributors from bypassing required agents, scripts, or checks.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md; mentions subagents; names the TodoWrite tool.

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

Reuse

Borrowing it

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

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

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/duquesnay/obsidian-mcp-ts/claude-md"><img src="https://agentmods.dev/badge/instructions/duquesnay/obsidian-mcp-ts/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 5,195 This file is loaded in full into every session.
When invoked 5,195 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.05195 $0.05195
Opus 5 $0.02597 $0.02597
Sonnet 5 $0.01039 $0.01039
Haiku 4.5 $0.00519 $0.00519

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

Security

Grade A, and why

obsidian-mcp-ts 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 9d 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.

- Check Obsidian plugin is running: `curl -k https://127.0.0.1:27124/`
CLAUDE.md · 599 lines

How it starts

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

Agent Usage Requirement

MANDATORY: Always use specialized agents for development work. Delegate all tasks using the Task tool - never perform complex work directly.

Project Overview

obsidian-mcp-ts is a TypeScript Model Context Protocol (MCP) server that provides an interface for AI assistants to interact with Obsidian vaults via the Local REST API community plugin. It enables reading, writing, searching, and managing notes programmatically.

Key Features:

  • Full TypeScript implementation with strict typing
  • Dynamic tool discovery with metadata and categorization
  • High-performance utilities (LRU cache, request deduplication, batch processing)
  • Comprehensive error handling with actionable suggestions
  • Clean architecture with separation of concerns

Development Commands

Setup and Dependencies

# Install dependencies
npm install

# Run in development mode with auto-reload
npm run dev

# Build TypeScript to JavaScript
npm run build

# Run built server
npm start

Testing

# Run all tests
npm test

# Run unit tests only
npm run test:unit

# Run integration tests
npm run test:integration

# Run E2E tests (requires Obsidian with REST API)
npm run test:e2e

# Test in watch mode
npm run test -- --watch

Debugging

# Use MCP Inspector for interactive debugging
npx @modelcontextprotocol/inspector tsx src/index.ts

# View logs on macOS
tail -f ~/Library/Logs/Claude/mcp-server-obsidian-mcp-ts.log

# Environment setup for development
export OBSIDIAN_API_KEY=your_api_key_here
export OBSIDIAN_HOST=127.0.0.1  # Optional, defaults to 127.0.0.1

Architecture

Core Components

  1. src/index.ts - MCP server entry point

    • Initializes server with stdio transport
    • Registers tools dynamically
    • Handles server lifecycle
  2. src/tools/ - Tool implementations

    • Each tool is a class extending BaseTool
    • Includes metadata (category, keywords, version)
    • Dynamic discovery at runtime
    • 33 tools across 6 categories

Read the full file on GitHub · 599 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. 9d ago First seen · 599 lines · 5,195 tokens per session scan A feb58cf68e2f

Subscribe to this mod's changes

obsidian-mcp-ts CLAUDE.md is an instructions file published in the GitHub repository duquesnay/obsidian-mcp-ts (5 stars, last pushed 5mo ago), licensed MIT. It adds 5,195 tokens to every session, about $0.0260 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-31.

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

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

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 3,735 tokens