What is obsidian-github-mcp CLAUDE.md?

A project instruction file for Obsidian GitHub MCP, a server that lets AI assistants read, search, and analyze Obsidian notes stored in GitHub repositories. It also lists development, testing, debugging, and code-quality commands.

Building and debugging the server, running its checks, inspecting logs, testing its tools, and working with GitHub-hosted Obsidian vaults.

It gives the coding agent the repository’s architecture and required commands, reducing mistakes when changing or checking the MCP server.

obsidian-github-mcp CLAUDE.md — Instructions file for coding agents by Hint-Services: A project instruction file for Obsidian GitHub MCP, a…

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/hint-services/obsidian-github-mcp/claude-md

Clone the repo

git clone --depth 1 https://github.com/Hint-Services/obsidian-github-mcp

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/hint-services/obsidian-github-mcp/claude-md.svg)](https://agentmods.dev/instructions/hint-services/obsidian-github-mcp/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/hint-services/obsidian-github-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/hint-services/obsidian-github-mcp/claude-md.svg" alt="Measured on agentmods" height="20"></a>

Per session 660 This file is loaded in full into every session.

When invoked 660 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.

Model	Per session	Once invoked
Fable 5	$0.00660	$0.00660
Opus 5	$0.00330	$0.00330
Sonnet 5	$0.00132	$0.00132
Haiku 4.5	$0.00066	$0.00066

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

Security

Grade A, and why

obsidian-github-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 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 · 56 lines

How it starts

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

Obsidian GitHub MCP is a Model Context Protocol (MCP) server that connects AI assistants to GitHub repositories containing Obsidian vaults. It enables seamless access to your knowledge base stored on GitHub, allowing AI assistants to read, search, and analyze your Obsidian notes and documentation.

Key Commands

Development

pnpm install - Install dependencies
pnpm run build - Build the project (includes linting and formatting)
pnpm run dev - Run in development mode with inspector
pnpm run watch - Watch mode for automatic recompilation
pnpm run debug:watch - Debug mode with watch

Code Quality

pnpm run lint:fix - Fix linting issues with Biome
pnpm run format:fix - Format code with Biome
pnpm run clean - Clean build artifacts

Debugging

pnpm run inspector - Launch MCP inspector for testing tools
pnpm run logs - View last 20 lines of MCP logs
pnpm run debug - Run with Node.js debugger attached

Architecture Overview

The project follows a clean modular architecture:

Core Components

src/index.ts: MCP server initialization using stdio transport. Handles server lifecycle, environment configuration, and graceful shutdown.
src/github/client.ts: Encapsulates all GitHub API interactions via Octokit. Implements centralized error handling and tool registration.
src/github/types.ts: TypeScript type definitions for configuration.

Available MCP Tools

getFileContents: Retrieves contents of specific notes, documents, or files from your Obsidian vault
searchFiles: Searches for notes and documents within your vault using GitHub's search syntax (paginated)
searchIssues: Searches for issues and discussions related to your knowledge base projects
getCommitHistory: Tracks how your knowledge base has evolved over time with detailed commit history and diffs

Read the full file on GitHub · 56 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.

4d ago First seen · 56 lines · 660 tokens per session scan A a95ea29f1f62

Subscribe to this mod's changes

obsidian-github-mcp CLAUDE.md is an instructions file published in the GitHub repository Hint-Services/obsidian-github-mcp (9 stars, last pushed 9mo ago), licensed MIT. It adds 660 tokens to every session, about $0.0033 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.

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

obsidian-github-mcp CLAUDE.md