markdown-vault-mcp: Instructions file for Claude Code

AGENTS.md

markdown-vault-mcp AGENTS.md is an instructions file for Claude Code, Codex, OpenCode from pvliesdonk/markdown-vault-mcp. It costs 5,187 tokens per session, scanned A, original, MIT.

A project instruction file for a Markdown Vault MCP server with hybrid search. A Markdown vault is a collection of Markdown notes, while hybrid search combines more than one way of finding relevant text.

In plain words
What is it for?
Maintaining note indexing and search, document and link management, backlink handling, text matching, filesystem traversal, and conversion of results into JSON.
Why use it?
It gives developers a shared design and project structure to follow when changing the server. This helps keep note handling, links, search, filesystem access, and serialization consistent.

Instructions file for Claude CodeCodexOpenCode

Written for Claude Code and Codex and OpenCode: Claude Code plugin machinery, but also the file is AGENTS.md. Also seen: reads .claude/ paths; mentions Claude Code; mentions AGENTS.md.

This is pvliesdonk/markdown-vault-mcp's own configuration. It tells Claude Code, Codex and OpenCode how to work on markdown-vault-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 markdown-vault-mcp configures →

Reuse

Borrowing it

Nothing to install: this file belongs to pvliesdonk/markdown-vault-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/pvliesdonk/markdown-vault-mcp/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/pvliesdonk/markdown-vault-mcp

Made for: Claude Code, Codex, OpenCode.

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 markdown-vault-mcp AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/pvliesdonk/markdown-vault-mcp/agents-md.svg)](https://agentmods.dev/instructions/pvliesdonk/markdown-vault-mcp/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/pvliesdonk/markdown-vault-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/pvliesdonk/markdown-vault-mcp/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 5,187 This file is loaded in full into every session.
When invoked 5,187 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.05187 $0.05187
Opus 5 $0.02593 $0.02593
Sonnet 5 $0.01037 $0.01037
Haiku 4.5 $0.00519 $0.00519

Measured today against content hash 6f6a1a114f96, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

markdown-vault-mcp AGENTS.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 today.

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.

AGENTS.md · 249 lines

How it starts

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

Markdown Vault MCP

Generic markdown vault MCP with hybrid search

Design

The authoritative design specification lives at docs/design/design.md. All implementation must conform to this spec. When in doubt, the design doc wins.

Project Structure

The complete file-by-file map of src/markdown_vault_mcp/ lives in docs/design/module-map.md — read it when locating a module or adding one, rather than guessing from the package layout. It is kept out of this always-loaded file because it is reference material consulted on demand, not context every session needs.

Conventions

  • Python 3.11+
  • uv for package management, ruff for linting/formatting (line length 88)
  • hatchling build backend
  • Conventional commits, one type from build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test — optionally scoped (feat(search): ...) and with ! for a breaking change. Only feat, fix, and the ! marker drive releases: feat cuts a minor, fix a patch, ! a major. Every other type — perf included — cuts nothing and never reaches CHANGELOG.md; a performance change that must ship on its own is either honestly a fix: (it fixes a performance defect) or released with Release Prepare's explicit override_version input.
  • Google-style docstrings on all public functions
  • logging.getLogger(__name__) throughout, no print()
  • Type hints everywhere
  • Tests: pytest with fixtures in tests/fixtures/

Pull-request titles are enforced, not merely encouraged. A squash merge takes the PR title as the commit subject, so CI's PR Title job checks it against the type list above and fails the CI Success aggregate when it does not match. This is not style policing: knope computes versions and writes CHANGELOG.md from those subjects, and it silently ignores a subject whose type it does not count — no fallback heading, no entry, no warning. That silent-drop class is exactly what the gate exists for: it keeps the history parseable and the accepted set deliberate. The changelog itself carries three sections per release — Breaking Changes first, then Features, then Bug Fixes — fed only by !/feat/fix subjects; the richness for everything else lives on the docs/releases/ notes page, not in the changelog.

Read the full file on GitHub · 249 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. today Changed · +3 lines · +300 tokens per session 6f6a1a114f96
  2. yesterday Changed · -3 tokens per session 30afc41a3641
  3. 3d ago Changed · -98 lines · -2,164 tokens per session cc1a1a2d3725
  4. 8d ago First seen · 344 lines · 7,054 tokens per session scan A a6c57c7a743d

Subscribe to this mod's changes

markdown-vault-mcp AGENTS.md is an instructions file published in the GitHub repository pvliesdonk/markdown-vault-mcp (32 stars, last pushed today), licensed MIT. It adds 5,187 tokens to every session, about $0.0259 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

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,182 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

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

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

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

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