Obsidian-TS-MCP: Instructions file for GitHub Copilot

.github/copilot-instructions.md

Obsidian-TS-MCP copilot-instructions.md is an instructions file for GitHub Copilot from dickiedyce/Obsidian-TS-MCP. It costs 481 tokens per session, scanned A, original, MIT.

Project instructions for Obsidian-TS-MCP, a TypeScript server that lets AI agents manage notes in an Obsidian vault through the Model Context Protocol.

In plain words
What is it for?
Use it when developing or testing the server that reads, writes, searches, and manages Obsidian notes through the Obsidian command-line tool.
Why use it?
It gives coding agents the project’s architecture, conventions, validation rules, and testing setup so changes fit the existing code.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is dickiedyce/Obsidian-TS-MCP's own configuration. It tells GitHub Copilot how to work on Obsidian-TS-MCP 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-TS-MCP configures →

Reuse

Borrowing it

Nothing to install: this file belongs to dickiedyce/Obsidian-TS-MCP. 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/dickiedyce/Obsidian-TS-MCP/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/dickiedyce/Obsidian-TS-MCP

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

README.md
[![agentmods](https://agentmods.dev/badge/instructions/dickiedyce/obsidian-ts-mcp/copilot-instructions.svg)](https://agentmods.dev/instructions/dickiedyce/obsidian-ts-mcp/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/dickiedyce/obsidian-ts-mcp/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/dickiedyce/obsidian-ts-mcp/copilot-instructions.svg" alt="Measured on agentmods" height="20"></a>
Per session 481 This file is loaded in full into every session.
When invoked 481 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.00481 $0.00481
Opus 5 $0.00241 $0.00241
Sonnet 5 $0.00096 $0.00096
Haiku 4.5 $0.00048 $0.00048

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

Security

Grade A, and why

Obsidian-TS-MCP 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 8d 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.

.github/copilot-instructions.md · 38 lines

How it starts

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

Obsidian-TS-MCP -- Copilot Instructions

This is an MCP server written in TypeScript that wraps the official Obsidian CLI (v1.12+). It exposes 41 tools over the Model Context Protocol for AI agents to read, write, search, and manage notes in an Obsidian vault.

Project context

  • Language: TypeScript (ES2022, Node16 module resolution, strict mode).
  • Build: tsc to dist/. No bundler.
  • Test framework: Vitest. Tests live in tests/ and mock the CLI layer.
  • Runtime dependency: @modelcontextprotocol/sdk (reference MCP SDK).
  • External dependency: The obsidian CLI binary, which requires the Obsidian desktop app to be running and a Catalyst licence.

Architecture

Module Role
src/cli.ts Low-level CLI wrapper (runObsidian, buildArgs, ObsidianCliError).
src/fs-ops.ts Direct filesystem operations for vault file management, bypassing CLI when exact path control is needed.
src/tools.ts 41 MCP tool definitions (names, descriptions, JSON schemas).
src/handlers.ts Dispatches tool calls to CLI commands or filesystem ops (handleTool).
src/validation.ts Input validation against tool schemas (validateInput, ValidationError).
src/server.ts MCP server entry-point (stdio transport, error formatting).

Coding conventions

  • Prefer explicit types over inference for exported functions.
  • Use JSDoc @module headers on every source file.
  • Keep tool definitions in tools.ts and handler logic in handlers.ts strictly separated.
  • Boolean CLI flags are passed as bare names (no =true). String and number params use key=value format.
  • Do not use emojis in code comments, commit messages, or documentation.
  • When adding a new tool: add the definition in tools.ts, the handler case in handlers.ts, and tests in both handlers.test.ts and tools.test.ts.

Read the full file on GitHub · 38 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. 8d ago First seen · 38 lines · 481 tokens per session scan A 8447da351b95

Subscribe to this mod's changes

Obsidian-TS-MCP copilot-instructions.md is an instructions file published in the GitHub repository dickiedyce/Obsidian-TS-MCP (13 stars, last pushed 28d ago), licensed MIT. It adds 481 tokens to every session, about $0.0024 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.

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

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,104 tokens