obsidian-mcp-server: Instructions file for GitHub Copilot

.github/copilot-instructions.md

obsidian-mcp-server copilot-instructions.md is an instructions file for GitHub Copilot from frstlvl/obsidian-mcp-server. It costs 4,268 tokens per session, scanned A, original, MIT.

Project instructions for an Obsidian MCP server, a program that lets Claude search and read notes stored in Obsidian vaults. They cover the project overview, issue tracking, and how the server communicates with Claude.

In plain words
What is it for?
Use them when modifying the server, its vault and note tools, its multi-vault setup, or its Beads issue-tracking process.
Why use it?
They provide the context needed to work on the project correctly, including its JSON-RPC communication, vault access, available tools, and development workflow.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is frstlvl/obsidian-mcp-server's own configuration. It tells GitHub Copilot how to work on obsidian-mcp-server 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-server configures →

Needs its repository: it runs a file that does not travel with it, so clone the repository first. The line is node dist/index.js.

Reuse

Borrowing it

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

Made for: GitHub Copilot.

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-server copilot-instructions.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/frstlvl/obsidian-mcp-server/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/frstlvl/obsidian-mcp-server/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 4,268 This file is loaded in full into every session.
When invoked 4,268 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.04268 $0.04268
Opus 5.5 $0.01707 $0.01707
Sonnet 5.5 $0.00854 $0.00854
Haiku 4.5 $0.00427 $0.00427

Measured 1mo ago against content hash 9d7785ad5752, 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-server copilot-instructions.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 1mo 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.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

.github/copilot-instructions.md · 635 lines

How it starts

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

Obsidian MCP Server - AI Instructions

Project Overview

This is a Model Context Protocol (MCP) server that provides real-time Claude AI access to Obsidian vaults. The server enables dynamic querying, searching, and reading of notes without token limitations through JSON-RPC 2.0 over stdio.

Key Purpose: Bridge Claude AI with Obsidian knowledge bases through efficient, secure, real-time vault access.

Issue Tracking

This project uses bd (beads) for issue tracking. Run bd prime for workflow context.

Quick reference:

  • bd ready - Find unblocked work
  • bd create "Title" --description "Description" --type task --priority 2 - Create issue
  • bd close <id> - Complete work
  • bd sync - Sync with git

Critical Project Context

MCP Architecture (CRITICAL)

  • Protocol: JSON-RPC 2.0 over stdio (stdin/stdout), NOT REST/HTTP
  • Server Model: Long-running process with structured message communication
  • Resources: Vault notes exposed as obsidian://vault/[path] URIs
  • Tools: Functions callable by Claude (list_vaults, search_vault, create_note, etc.)
  • Multi-Vault: Single server instance serving multiple vaults via vaults config array
  • Implementation: TypeScript using @modelcontextprotocol/sdk

Technology Stack

Runtime & Build:

  • Node.js 18+ (recommended 20+)
  • TypeScript 5.7+ with strict mode
  • ES Modules (type: "module" in package.json)

Core Dependencies:

  • @modelcontextprotocol/sdk - MCP protocol implementation
  • @xenova/transformers - Local embedding generation (Transformers.js)
  • vectra - Local vector database for semantic search
  • chokidar - File system watcher for automatic index updates
  • winston - Structured logging system
  • gray-matter - YAML frontmatter parsing
  • zod - Runtime type validation

Development:

  • tsx - TypeScript execution and hot reload
  • prettier - Code formatting
  • eslint - Code linting

Project Structure

obsidian-mcp-server/
├── src/
│   ├── index.ts              # Entry point, server initialization
│   ├── obsidian-server.ts    # MCP request handlers (resources, tools)
│   ├── vault-registry.ts    # Multi-vault context management
│   ├── embeddings.ts         # Vector store and embedding generation
│   ├── search.ts             # Keyword search implementation
│   ├── utils.ts              # Config loading, path helpers
│   ├── logger.ts             # Winston logging configuration
│   └── indexing-worker.ts    # Background indexing worker process
├── docs/
│   ├── configuration.md      # Configuration options
│   ├── indexing-workflow.md  # Indexing procedures and troubleshooting
│   ├── semantic-search.md    # Search implementation details
│   └── vector-search.md      # Vector search architecture
├── scripts/
│   └── inspect-yaml-issues.ps1  # YAML frontmatter debugging
├── .github/
│   ├── copilot-instructions.md  # This file
│   ├── obsidian-mcp-server.code-workspace  # VS Code workspace
│   └── README.md             # GitHub folder documentation
├── config.json               # Runtime configuration (gitignored)
├── config.example.json       # Configuration template
└── package.json              # Dependencies and scripts

Read the full file on GitHub · 635 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. 1mo ago First seen · 635 lines · 4,268 tokens per session scan A 9d7785ad5752

Subscribe to this mod's changes

obsidian-mcp-server copilot-instructions.md is an instructions file published in the GitHub repository frstlvl/obsidian-mcp-server (1 stars, last pushed 6mo ago), licensed MIT. It adds 4,268 tokens to every session, about $0.0171 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

Other instructions, from other repositories

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 · 9,649 tokens

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,384 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens