What is ObsidianMCPServer CLAUDE.md?

A contributor guide for ObsidianMCPServer, a Swift program that connects AI tools to Obsidian, a note-taking app, through its local REST API. It documents how to build, install, configure, and test the server.

Use it when developing, testing, installing, or configuring ObsidianMCPServer, including its Obsidian URL and API key.

It gives developers the repository-specific commands and settings needed to work on the project. This reduces guesswork when building releases or running its 280-plus tests.

ObsidianMCPServer CLAUDE.md — Instructions file for coding agents by otaviocc: A contributor guide for ObsidianMCPServer, a Swift program th

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/otaviocc/obsidianmcpserver/claude-md

Clone the repo

git clone --depth 1 https://github.com/otaviocc/ObsidianMCPServer

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/otaviocc/obsidianmcpserver/claude-md.svg)](https://agentmods.dev/instructions/otaviocc/obsidianmcpserver/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/otaviocc/obsidianmcpserver/claude-md"><img src="https://agentmods.dev/badge/instructions/otaviocc/obsidianmcpserver/claude-md.svg" alt="Measured on agentmods" height="20"></a>

Per session 1,532 This file is loaded in full into every session.

When invoked 1,532 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.01532	$0.01532
Opus 5	$0.00766	$0.00766
Sonnet 5	$0.00306	$0.00306
Haiku 4.5	$0.00153	$0.00153

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

Security

Grade A, and why

ObsidianMCPServer 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 5d 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 · 168 lines

How it starts

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

Common Development Commands

Building and Testing

Build development: swift build
Build release: swift build -c release
Run tests: swift test (280+ test cases across all modules)
Clean build: swift package clean

Installation Options

From source: swift build -c release (executable at .build/release/ObsidianMCPServer)
Via Homebrew: brew tap otaviocc/mcp && brew install obsidian-mcp-server (executable at /opt/homebrew/bin/obsidian-mcp-server)
Via Mint: mint install otaviocc/ObsidianMCPServer (executable at $HOME/.mint/bin/ObsidianMCPServer)

Runtime Configuration

The server requires these environment variables:

OBSIDIAN_BASE_URL: URL of the Obsidian Local REST API (typically http://127.0.0.1:27123)
OBSIDIAN_API_KEY: API key from the Obsidian Local REST API plugin

Architecture Overview

This is a Swift-based Model Context Protocol (MCP) server that bridges AI tools with Obsidian vaults through the Local REST API plugin. The architecture follows a clean, modular design with clear separation of concerns.

Module Structure

ObsidianMCPServer/: Main executable with MCP server implementation and CLI entry point
ObsidianModels/: Core enum definitions (Language, WritingStyle, AnalysisFocus, etc.)
ObsidianNetworking/: HTTP client layer with factories and response models
ObsidianRepository/: Data access layer implementing vault operations
ObsidianPrompt/: AI prompt generation for analysis and transformation tasks
ObsidianResource/: MCP resource endpoints for enum discovery

Key Dependencies

SwiftMCP: Core MCP protocol implementation (from Cocoanetics)
MicroClient: HTTP networking client
ArgumentParser: CLI interface
AnyCodable: JSON handling utilities

MCP Integration Pattern

The server uses the @MCPServer, @MCPTool, @MCPPrompt, and @MCPResource attributes to expose functionality:

Tools: Direct vault operations (CRUD, search, frontmatter management)
Prompts: Structured templates for AI analysis and content transformation
Resources: Enum discovery endpoints for dynamic parameter options

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

5d ago First seen · 168 lines · 1,532 tokens per session scan A c2b26fbfbf10

Subscribe to this mod's changes

ObsidianMCPServer CLAUDE.md is an instructions file published in the GitHub repository otaviocc/ObsidianMCPServer (16 stars, last pushed 3mo ago), licensed MIT. It adds 1,532 tokens to every session, about $0.0077 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.

ai mcp mcp-server obsidian obsidian-md swift

mcp-obsidian-via-rest CLAUDE.md

Instructions for OleksandrKucherenko/mcp-obsidian-via-rest, covering claude.md, project overview, development commands, building and running and install dependencies.

OleksandrKucherenko/mcp-obsidian-via-rest · 3,822 tokens

obsidian-cli-rest AGENTS.md

Instructions for dsebastien/obsidian-cli-rest, covering project documentation, documentation surfaces, project overview, agent workflow and session-start checklist.

dsebastien/obsidian-cli-rest · 8,788 tokens

obsidian-cli-rest CLAUDE.md

Instructions for dsebastien/obsidian-cli-rest, a project described as: Control your Obsidian vault programmatically. This plugin turns all Obsidian CLI commands into a local HTTP API and MCP server, letting you automate your workflow from scripts, tools, and AI assistants.

dsebastien/obsidian-cli-rest · 7 tokens

ObsidianMCPServer CLAUDE.md