io.github.pvliesdonk/markdown-vault-mcp

Official

by pvliesdonk · Python

Markdown Vault MCP

Markdown vault MCP server with FTS5 + semantic search and frontmatter indexing

Search and index Markdown documents with full-text and semantic search capabilities.

Topics

claudeembeddingsfastmcpfts5knowledge-basemarkdownmcpmcp-servermodel-context-protocolobsidianpythonsearchsemantic-searchsqlitevault

README.md43 KBView on GitHub

markdown-vault-mcp

A generic markdown vault MCP server with FTS5 full-text search, semantic vector search, frontmatter-aware indexing, incremental reindexing, and non-markdown attachment support.

Documentation | Config wizard | PyPI | Docker

Point it at a directory of Markdown files (an Obsidian vault, a docs folder, a Zettelkasten, a PARA vault) and it exposes search, read, write, and edit tools over the Model Context Protocol.

Features

Full-text search — SQLite FTS5 with BM25 scoring, porter stemming
Semantic search — cosine similarity over embedding vectors (FastEmbed, Ollama, or OpenAI)
Hybrid search — Reciprocal Rank Fusion combining FTS5 and vector results
Diversity-aware ranking — each search result list caps a single document at 2 chunks (configurable), downweights chunks of long documents, and returns sentence-scale snippets — bounded LLM context cost per query, with full-section recovery via read(path, section=heading)
Adaptive heading-level chunking — long sections are recursively re-split at deeper heading levels (H1 → H6) until each chunk fits a configurable word budget, improving retrieval precision on synthesising essays without manual restructuring

Upgrading. As of this release, search returns query-relevant snippets in the content field by default (approximately 200 words). Pass snippet_words=0 to recover the prior full-chunk behaviour, or use read(path, section=heading) to fetch the full section after seeing a snippet. Documents are also re-chunked on next reindex to honour the adaptive MARKDOWN_VAULT_MCP_MAX_CHUNK_WORDS threshold (default 400).

Frontmatter-aware — indexes YAML frontmatter fields, supports required field enforcement
Incremental reindexing — hash-based change detection, only re-processes modified files; an automatic boot-time reconciliation pass picks up changes made while no server was running, and the vector index converges to the reconciled chunk set (embedding exactly the delta)
Write operations — create, edit, delete, rename documents, and move entire folder subtrees with automatic index updates
Attachment support — read, write, delete, and list non-markdown files (PDFs, images, etc.)
Git integration — optional auto-commit and push on every write via GIT_ASKPASS
OIDC authentication — optional token-based auth for HTTP deployments (Authelia, Keycloak, etc.)
MCP tools — 32 LLM-visible tools including search, read, write, edit, delete, rename, move_folder, git history, manual git sync, one-time transfer links, and admin operations; plus 6 app-only tools for MCP Apps clients
MCP resources — 9 resources exposing vault configuration, statistics, tags, folders, document outlines, similar notes, recent notes, and an interactive SPA
MCP prompts — 7 prompt templates including template-driven note creation

What you can do with it

With this server mounted in Claude, you can:

Capture a URL as a note. "Fetch <url>, summarize as a Resource note under 3-Resources/, and link any existing notes on the topic." — Claude composes fetch + search + write.
Research a topic into your vault. "Research product security regulations, compare them, and create a set of interlinked notes — one per regulation, plus a map-of-content." — Claude composes web-search tools (client-side) + write with wikilinks. See the Research workflows guide for the full loop.
Distill today's thinking. "Summarize today's conversations into Inbox notes." — Claude.ai only; uses conversation_search + recent_chats + write. The para-capture-chats prompt is the one-click version.
Find missing links. Fire the propose-links prompt from the + menu — it scans recently-modified notes, proposes meaningful connections, and writes them on confirmation.
Split or merge captures. "Split this Inbox note into two." / "Merge this into <existing note> instead of duplicating." — Claude composes read + write + delete.

No external scheduler, no separate capture app — the vault sits behind your conversations and absorbs their output.

Installation

From PyPI

bash

pip install markdown-vault-mcp

With optional dependencies:

bash

pip install markdown-vault-mcp[mcp]            # FastMCP server
pip install markdown-vault-mcp[embeddings-api]  # Ollama/OpenAI embeddings via HTTP
pip install markdown-vault-mcp[embeddings]      # FastEmbed local embeddings
pip install markdown-vault-mcp[all]             # MCP + FastEmbed + API embeddings

From source

bash

git clone https://github.com/pvliesdonk/markdown-vault-mcp.git
cd markdown-vault-mcp
uv sync --all-extras --all-groups

Docker

bash

docker pull ghcr.io/pvliesdonk/markdown-vault-mcp:latest

The Docker image uses [all] (MCP + FastEmbed + API embeddings). By default, semantic search works locally with FastEmbed and can switch to Ollama/OpenAI when configured. A compose.yml ships at the repo root as a starting point — copy .env.example to .env, edit, and docker compose up -d.

To attach a remote Python debugger (development only; the protocol is unauthenticated), see Remote debugging.

Linux packages (.deb / .rpm)

Download .deb or .rpm packages from the GitHub Releases page. Both install a hardened systemd unit; env configuration is sourced from /etc/markdown-vault-mcp/env (copy from the shipped /etc/markdown-vault-mcp/env.example). See the systemd deployment guide for details.

Claude Desktop (.mcpb bundle)

Download the .mcpb bundle from the GitHub Releases page. Double-click to install, or run:

bash

mcpb install markdown-vault-mcp-<version>.mcpb

Claude Desktop opens a GUI wizard that prompts for required env vars — no manual JSON editing needed. See Step 0 of the Claude Desktop guide for details.

Claude Code plugin

code

/plugin marketplace add pvliesdonk/claude-plugins
/plugin install markdown-vault-mcp@pvliesdonk

Installs the MCP server and the vault-workflow skill. See the Claude Code plugin guide for details.

Quick Start

As a library

python

from pathlib import Path
from markdown_vault_mcp import Vault

vault = Vault(source_dir=Path("/path/to/vault"))
vault.index.build_index()
results = vault.reader.search("query text", limit=10)

As an MCP server

bash

export MARKDOWN_VAULT_MCP_SOURCE_DIR=/path/to/vault
markdown-vault-mcp serve

With Docker Compose

Copy an example env file:
bash
```
cp examples/obsidian-readonly.env .env
```
Edit .env to set MARKDOWN_VAULT_MCP_SOURCE_DIR to the absolute path of your vault on the host.
Start the service:
bash
```
docker compose up -d
```

Check the logs:

bash

docker compose logs -f markdown-vault-mcp

Example env files

File	Description
`examples/obsidian-readonly.env`	Obsidian vault, read-only, Ollama embeddings
`examples/obsidian-readwrite.env`	Obsidian vault, read-write with git auto-commit
`examples/obsidian-oidc.env`	Obsidian vault, read-only, OIDC authentication (Authelia)
`examples/ifcraftcorpus.env`	Strict frontmatter enforcement, read-only corpus

For reverse proxy (Traefik) and deployment setup, see docs/deployment.md.

Server info

The server registers a built-in get_server_info tool (via fastmcp_pvl_core.register_server_info_tool) so operators can confirm the deployed version with a single MCP call. The response carries server_name, server_version, and core_version.

Configuration

All configuration is via environment variables with the MARKDOWN_VAULT_MCP_ prefix (except embedding provider settings, which use their own conventions).

Configuration Generator: in-browser config / Docker / systemd builder

Core

Variable	Default	Required	Description
`MARKDOWN_VAULT_MCP_SOURCE_DIR`	—	Yes	Path to the markdown vault directory
`MARKDOWN_VAULT_MCP_READ_ONLY`	`true`	No	Set to `false` to enable write operations
`MARKDOWN_VAULT_MCP_INDEX_PATH`	in-memory	No	Path to the SQLite FTS5 index file; set for persistence across restarts
`MARKDOWN_VAULT_MCP_EMBEDDINGS_PATH`	disabled	No	Path to the numpy embeddings file; required to enable semantic search
`MARKDOWN_VAULT_MCP_STATE_PATH`	`{SOURCE_DIR}/.markdown_vault_mcp/state.json`	No	Path to the change-tracking state file
`MARKDOWN_VAULT_MCP_INDEXED_FIELDS`	—	No	Comma-separated frontmatter fields to promote to the tag index for structured filtering
`MARKDOWN_VAULT_MCP_REQUIRED_FIELDS`	—	No	Comma-separated frontmatter fields required on every document; documents missing any are excluded from the index
`MARKDOWN_VAULT_MCP_EXCLUDE`	—	No	Comma-separated glob patterns to exclude from scanning (e.g. `.obsidian/,.trash/`)
`MARKDOWN_VAULT_MCP_TEMPLATES_FOLDER`	`_templates`	No	Relative folder path where note templates live (used by the `create_from_template` prompt)
`MARKDOWN_VAULT_MCP_PROMPTS_FOLDER`	—	No	Path to a directory of `.md` prompt files that extend or override built-in prompts (see User-defined prompts)
`MARKDOWN_VAULT_MCP_DRAIN_TIMEOUT_S`	`60`	No	Maximum seconds an index-querying read tool waits for the IndexWriter to drain when called with `wait_for_pending_writes=True`. On timeout the tool answers from the current index rather than raising and reports `index_stale=True` in the response's `_meta`.
`MARKDOWN_VAULT_MCP_BUILD_TIMEOUT_S`	`60`	No	Maximum seconds a relational/FTS-backed tool or resource waits for the index to become queryable during a cold-start background build before raising `IndexUnavailableError(reason="timeout")`. Increase for very large vaults.

Server identity

Variable	Default	Description
`MARKDOWN_VAULT_MCP_SERVER_NAME`	`markdown-vault-mcp`	MCP server name shown to clients; useful for multi-instance setups
`MARKDOWN_VAULT_MCP_INSTRUCTIONS`	(auto)	System-level instructions injected into LLM context; defaults to a description that reflects read-only vs read-write state
`MARKDOWN_VAULT_MCP_DISABLE_APPS_UI`	`false`	Hide MCP-Apps UI tools (`browse_vault`, `show_context`) from the tool listing for clients that do not render MCP Apps panels (saves a few listing tokens)
`MARKDOWN_VAULT_MCP_HTTP_PATH`	`/mcp`	HTTP endpoint path for streamable HTTP transport (used by `serve --transport http`)
`MARKDOWN_VAULT_MCP_KV_STORE_URL`	`file:///data/state`	Unified key-value backend for HTTP session persistence (the `events` keyspace is namespaced inside the directory). `file:///path` (default) survives restarts; `memory://` for dev (lost on restart). Preferred over `EVENT_STORE_URL`.
`MARKDOWN_VAULT_MCP_EVENT_STORE_URL`	(unset)	Legacy alias for `KV_STORE_URL`; honoured only when `KV_STORE_URL` is unset, and logs a one-shot deprecation warning. Prefer `KV_STORE_URL`.
`MARKDOWN_VAULT_MCP_APP_DOMAIN`	(auto)	Override the Claude app domain used for MCP Apps iframe sandboxing. Auto-computed from `BASE_URL` when not set.
`FASTMCP_LOG_LEVEL`	`INFO`	Log level for FastMCP internals (`DEBUG`, `INFO`, `WARNING`, `ERROR`). App loggers default to `INFO`. `-v` overrides both to `DEBUG`.
`FASTMCP_ENABLE_RICH_LOGGING`	`true`	Rich `key=value` text by default. Set to `false` for one-JSON-object-per-record output — recommended for production / log-aggregator deployments.

Search and embeddings

Variable	Default	Description
`MARKDOWN_VAULT_MCP_EMBEDDING_PROVIDER`	auto-detect	Embedding provider: `openai`, `ollama`, or `fastembed`
`OLLAMA_HOST`	`http://localhost:11434`	Ollama server URL (not `MARKDOWN_VAULT_MCP_`-prefixed)
`OPENAI_API_KEY`	—	OpenAI API key for the OpenAI embedding provider (not `MARKDOWN_VAULT_MCP_`-prefixed)
`MARKDOWN_VAULT_MCP_OPENAI_BASE_URL` / `OPENAI_BASE_URL`	`https://api.openai.com/v1`	OpenAI-compatible API base URL for embeddings
`MARKDOWN_VAULT_MCP_OPENAI_EMBEDDING_MODEL` / `OPENAI_EMBEDDING_MODEL`	`text-embedding-3-small`	OpenAI-compatible embedding model name
`MARKDOWN_VAULT_MCP_OLLAMA_MODEL`	`nomic-embed-text`	Ollama embedding model name
`MARKDOWN_VAULT_MCP_OLLAMA_CPU_ONLY`	`false`	Force Ollama to use CPU only
`MARKDOWN_VAULT_MCP_FASTEMBED_MODEL`	`BAAI/bge-small-en-v1.5`	FastEmbed model name
`MARKDOWN_VAULT_MCP_FASTEMBED_CACHE_DIR`	FastEmbed default	FastEmbed model cache directory (in Docker, stored under `/data/state/fastembed`)
`MARKDOWN_VAULT_MCP_MAX_CHUNK_WORDS`	`400`	Word cap per chunk; the adaptive chunker splits at deeper heading levels, then paragraph/word boundaries, to respect it. Match it to the embedding model's context. A non-zero `CHUNK_OVERLAP_WORDS` can push an overlapped fragment past this cap. A reindex applies a new value.
`MARKDOWN_VAULT_MCP_MAX_CHUNK_CHARS`	(bounded default)	Character cap the chunker enforces alongside `MAX_CHUNK_WORDS` to bound token-dense chunks (CJK, code, tables) that fit the word cap yet exceed the model's token context. Unset → `min(1500, round(context_length × 2.8))`, so the default stays retrieval-sized and memory-safe regardless of model context. The default `BAAI/bge-small-en-v1.5` (512 tokens) derives ~1434 chars, below the ceiling and unchanged; a longer-context model (context above ~536 tokens) is capped at 1500; an unknown context falls back to 1500. Set a positive value to force an exact cap. Set `-1` to scale with the model's full context with no ceiling, or 1500 when the context is unknown, which can OOM the fastembed/ONNX path on a long-context model. A reindex applies a new value.
`MARKDOWN_VAULT_MCP_CHUNK_OVERLAP_WORDS`	`40`	Words of overlap between adjacent budget-split fragments of the same heading section (`0` disables). Applies to new/re-indexed notes; run `reindex` to apply to an existing vault.
`MARKDOWN_VAULT_MCP_CHUNKS_PER_FILE`	`2`	Maximum chunks returned per document in `search` results.
`MARKDOWN_VAULT_MCP_SNIPPET_WORDS`	`200`	Width of the snippet window (words) in `search` results; `0` returns full chunk content.
`MARKDOWN_VAULT_MCP_LENGTH_DOWNWEIGHT_ALPHA`	`0.25`	Down-weights longer chunks in ranking (`score / (1 + alpha · log(chunk_count))`).

Note: the chunker's character cap (MARKDOWN_VAULT_MCP_MAX_CHUNK_CHARS) is derived from the embedding model's context length, so changing the embedding model re-chunks the FTS index — not just the embeddings — and triggers an automatic cold rebuild of the index on the next startup. The defaults stay memory-light (BAAI/bge-small-en-v1.5 for FastEmbed, nomic-embed-text for Ollama); long-context models — nomic-ai/nomic-embed-text-v1.5 (8192 tokens) for FastEmbed, or bge-m3:latest for Ollama — are opt-in and need substantially more RAM/VRAM during indexing.

Git integration

Git integration has three modes:

Managed mode (MARKDOWN_VAULT_MCP_GIT_REPO_URL set): server owns repo setup. On startup it clones into SOURCE_DIR when empty, or validates existing origin. Pull loop + auto-commit + deferred push are enabled.
Unmanaged / commit-only mode (no GIT_REPO_URL): writes are committed to a local git repo if SOURCE_DIR is already a git checkout. No pull, no push.
No-git mode: if SOURCE_DIR is not a git repo, git callbacks are no-ops.

When token auth is used (MARKDOWN_VAULT_MCP_GIT_TOKEN), remotes must be HTTPS. SSH remotes (for example git@github.com:owner/repo.git) are rejected with a startup error. Fix with: git -C /path/to/vault remote set-url origin https://github.com/owner/repo.git

Backward compatibility: MARKDOWN_VAULT_MCP_GIT_TOKEN without GIT_REPO_URL still works (legacy mode) but logs a deprecation warning.

Variable	Default	Description
`MARKDOWN_VAULT_MCP_GIT_REPO_URL`	—	HTTPS remote URL for managed mode; enables clone/remote validation on startup
`MARKDOWN_VAULT_MCP_GIT_USERNAME`	`x-access-token`	Username for HTTPS auth prompts (`x-access-token` for GitHub, `oauth2` for GitLab, account name for Bitbucket)
`MARKDOWN_VAULT_MCP_GIT_TOKEN`	—	Token/password for HTTPS auth (`GIT_ASKPASS`)
`MARKDOWN_VAULT_MCP_GIT_PULL_INTERVAL_S`	`600`	Seconds between `git fetch` + ff-only update attempts; `0` disables periodic pull
`MARKDOWN_VAULT_MCP_GIT_PUSH_DELAY_S`	`30`	Seconds of write-idle time before pushing; `0` = push only on shutdown
`MARKDOWN_VAULT_MCP_GIT_COMMIT_NAME`	`markdown-vault-mcp`	Git committer name for auto-commits; set this in Docker where `git config user.name` is empty
`MARKDOWN_VAULT_MCP_GIT_COMMIT_EMAIL`	`noreply@markdown-vault-mcp`	Git committer email for auto-commits
`MARKDOWN_VAULT_MCP_GIT_COMMIT_NAME_CLAIM`	—	OIDC claim key to use as the commit author name (e.g. `name`); overrides `GIT_COMMIT_NAME` per-request when an OIDC token is present
`MARKDOWN_VAULT_MCP_GIT_COMMIT_EMAIL_CLAIM`	—	OIDC claim key to use as the commit author e-mail (e.g. `email`); overrides `GIT_COMMIT_EMAIL` per-request when an OIDC token is present
`MARKDOWN_VAULT_MCP_GIT_LFS`	`true`	Enable Git LFS — runs `git lfs pull` on startup to fetch LFS-tracked attachments (PDFs, images). Set to `false` for repos without LFS.
`MARKDOWN_VAULT_MCP_GITHUB_WEBHOOK_SECRET`	—	Shared secret for GitHub push-event webhook; when set, mounts `POST /github-webhook` on HTTP/SSE transports to trigger immediate pull + reindex on push events

File Watcher

Variable	Default	Description
`MARKDOWN_VAULT_MCP_FILE_WATCHER`	`true`	Enable filesystem-event watcher for external changes; auto-disabled when git pull or webhook is active
`MARKDOWN_VAULT_MCP_FILE_WATCHER_DEBOUNCE_S`	`2.0`	Seconds of quiet after the last event before triggering reindex
`MARKDOWN_VAULT_MCP_FILE_WATCHER_ROOT_FLOOR`	`true`	Keep the non-recursive watch on the vault root; set `false` to register zero source-directory-rooted `FSEvents` streams (avoids repeated macOS access prompts on a `$HOME`-rooted vault), at the cost of root-level files relying on scans

Requires the watchdog optional extra: pip install 'markdown-vault-mcp[file-watcher]'. Automatically disabled when GIT_PULL_INTERVAL_S > 0 or GITHUB_WEBHOOK_SECRET is set. The watcher scopes one recursive watch per non-excluded top-level directory (not a single recursive watch on the root), so excluded directories are never registered and content under a deliberately watched dot-directory delivers its own edits. See docs/configuration.md for details.

Attachments

Non-markdown file support. See Attachments for details.

Variable	Default	Description
`MARKDOWN_VAULT_MCP_ATTACHMENT_EXTENSIONS`	(built-in list)	Comma-separated allowed extensions without dot (e.g. `pdf,png,jpg`); use `*` to allow all non-`.md` files
`MARKDOWN_VAULT_MCP_MAX_ATTACHMENT_SIZE_MB`	`1.0`	Maximum attachment size in MB returned by `read()` / accepted by `write()`; `0` disables the limit
`MARKDOWN_VAULT_MCP_MAX_NOTE_READ_BYTES`	`262144` (256 KB)	Maximum bytes returned by full-document `read()` for `.md` files; raises `ValueError` if exceeded. Use `read(path, section=...)` for partial reads. `0` disables the limit.

Bearer token authentication

Simple static token auth for HTTP deployments. Set a single env var — clients must send Authorization: Bearer <token>.

Variable	Required	Description
`MARKDOWN_VAULT_MCP_BEARER_TOKEN`	Yes	Static bearer token; any non-empty string enables auth

OIDC authentication

Full OAuth 2.1 authentication for HTTP deployments. OIDC activates when all four required variables are set. See Authentication for setup details.

Multi-auth: If both BEARER_TOKEN and all OIDC variables are set, the server accepts either credential — a valid bearer token or a valid OIDC session. This is useful when different clients use different auth flows (e.g. Claude web via OIDC and Claude Code via bearer token).

Variable	Required	Description
`MARKDOWN_VAULT_MCP_BASE_URL`	Yes	Public base URL of the server (e.g. `https://mcp.example.com`; include prefix if mounted under subpath, e.g. `https://mcp.example.com/vault`). Used for OIDC auth and to auto-compute the MCP Apps domain.
`MARKDOWN_VAULT_MCP_OIDC_CONFIG_URL`	Yes	OIDC discovery endpoint (e.g. `https://auth.example.com/.well-known/openid-configuration`)
`MARKDOWN_VAULT_MCP_OIDC_CLIENT_ID`	Yes	OIDC client ID registered with your provider
`MARKDOWN_VAULT_MCP_OIDC_CLIENT_SECRET`	Yes	OIDC client secret
`MARKDOWN_VAULT_MCP_OIDC_JWT_SIGNING_KEY`	No	JWT signing key; required on Linux/Docker — the default is ephemeral and invalidates tokens on restart. Generate with `openssl rand -hex 32`
`MARKDOWN_VAULT_MCP_OIDC_AUDIENCE`	No	Expected JWT audience claim; leave unset if your provider does not set one
`MARKDOWN_VAULT_MCP_OIDC_REQUIRED_SCOPES`	No	Comma-separated required scopes; default `openid`
`MARKDOWN_VAULT_MCP_OIDC_VERIFY_ACCESS_TOKEN`	No	Set `true` to verify the upstream access token as a JWT instead of the id token. Only needed when your provider issues JWT access tokens and you require audience-claim validation on that token. Default: verify the id token (works with all providers, including opaque-token issuers like Authelia)

CLI Reference

code

markdown-vault-mcp <command> [options]

`serve`

Start the MCP server.

bash

markdown-vault-mcp serve [--transport {stdio|sse|http}] [--host HOST] [--port PORT] [--http-path PATH]

Flag	Default	Description
`--transport`	`stdio`	MCP transport: `stdio` (stdin/stdout, default), `sse` (Server-Sent Events), `http` (streamable-HTTP). Use `http` for Docker with a reverse proxy or when OIDC is enabled.
`--host`	`127.0.0.1`	Bind host for the `http` transport (ignored for `stdio` and `sse`); pass `0.0.0.0` to bind all interfaces inside Docker
`--port`	`8000`	Port for the `http` transport (ignored for `stdio` and `sse`)
`--http-path` (alias `--path`)	env `MARKDOWN_VAULT_MCP_HTTP_PATH` or `/mcp`	MCP HTTP path for `http` transport; useful for reverse-proxy subpath mounting (e.g. `/vault/mcp`). The legacy `--path` spelling is still accepted.

Reverse Proxy Subpath Mounts

By default, HTTP transport serves MCP on /mcp. You can run it under a subpath:

bash

markdown-vault-mcp serve --transport http --http-path /vault/mcp

Equivalent env-based config:

bash

MARKDOWN_VAULT_MCP_HTTP_PATH=/vault/mcp

For reverse proxies, you can either:

Keep app path at /mcp and use proxy rewrite/strip-prefix middleware.
Set app path directly to the public path (/vault/mcp) and route without rewrite.

When OIDC is enabled under a subpath, the configuration is different: the subpath goes in BASE_URL only, and HTTP_PATH stays at /mcp. See OIDC subpath deployments.

Then your redirect URI is:

text

https://mcp.example.com/vault/auth/callback

`index`

Build the full-text search index.

bash

markdown-vault-mcp index [--source-dir PATH] [--index-path PATH] [--force]

`search`

Search the vault from the CLI.

bash

markdown-vault-mcp search <query> [-n LIMIT] [-m {keyword|semantic|hybrid}] [--folder PATH] [--json]

`reindex`

Incrementally reindex the vault (only processes changed files). When semantic search is configured, the vector index is converged to the updated chunk set — exactly the changed documents are re-embedded and orphaned vectors dropped, never the whole corpus.

bash

markdown-vault-mcp reindex [--source-dir PATH] [--index-path PATH]

MCP Tools

Tool	Description
`search`	Hybrid full-text + semantic search with optional frontmatter filters
`read`	Read a document or attachment by relative path
`write`	Create or overwrite a document or attachment
`edit`	Replace text in a document — exact match, line-range, or scoped match with normalized fallback
`delete`	Delete a document or attachment and its index entries
`rename`	Rename/move a document or attachment, updating all index entries; pass `update_links=true` to also rewrite backlinks in other notes
`move_folder`	Move an entire folder subtree to a new prefix, rewriting all vault links that point into the moved subtree in one call
`list_documents`	List indexed documents; pass `include_attachments=true` to also list non-markdown files
`list_folders`	List all folder paths in the vault
`list_tags`	List all unique frontmatter tag values
`reindex`	Force a full reindex of the vault
`stats`	Get vault statistics (document count, chunk count, link health metrics, etc.)
`build_embeddings`	Build or rebuild vector embeddings for semantic search
`embeddings_status`	Check embedding provider and index status
`get_index_status`	Check background FTS build state (`queryable` / `building` / `failed`)
`get_backlinks`	Find all documents that link to a given document
`get_outlinks`	Find all links from a document, with existence check
`get_broken_links`	Find all links pointing to non-existent documents
`get_similar`	Find semantically similar notes by document path
`get_toc`	Heading outline for a note or a folder subtree
`get_recent`	Get the most recently modified notes
`get_context`	Get a consolidated context dossier for a note (backlinks, outlinks, similar, folder peers, tags, modified time)
`get_orphan_notes`	Find all notes with no inbound or outbound links
`get_most_linked`	Find the most-linked-to notes ranked by backlink count
`get_connection_path`	Find the shortest path between two notes via BFS on the undirected link graph (max 10 hops)
`get_history`	List commits that touched a note, attachment, or the whole vault (git-backed vaults only)
`get_diff`	Return a diff of a note or attachment between a reference commit/timestamp and HEAD; binary attachments return a `--stat` size summary instead of a unified patch (git-backed vaults only)
`git_sync`	Force an immediate git pull / push / both, bypassing the periodic loops. Returns structured state (SHAs, commit counts, Syncthing-style conflict file paths if any). Hidden when `MARKDOWN_VAULT_MCP_GIT_REPO_URL` isn't set or `READ_ONLY=true`.
`fetch`	Download a file from a URL and save it to the vault as a note or attachment (MCP-to-MCP transfer)
`create_download_link`	Mint a one-time capability URL to download a vault note or attachment (HTTP/SSE only; `BASE_URL` required)
`create_upload_link`	Mint a one-time capability URL to upload bytes to a fixed vault path (HTTP/SSE only; `BASE_URL` required; hidden when `READ_ONLY=true`)
`browse_vault`	Open the vault explorer SPA in a supporting MCP Apps client
`show_context`	Open the Context Card for a specific note in a supporting MCP Apps client

Write tools (write, edit, delete, rename, move_folder, fetch, git_sync, create_upload_link) are only available when MARKDOWN_VAULT_MCP_READ_ONLY=false. git_sync additionally requires managed git mode (MARKDOWN_VAULT_MCP_GIT_REPO_URL set).

browse_vault and show_context are LLM-visible in all clients; when called in an MCP Apps-capable client they open the interactive SPA. Six additional internal tools (vault_context, vault_list, vault_read, vault_search, vault_graph_neighborhood, vault_graph_hubs) use visibility="app" and are used by the SPA only — they are never visible to the LLM.

Resources

MCP resources expose vault metadata as structured JSON that clients can read directly without invoking tools.

URI	Description
`config://vault`	Current vault configuration (source dir, indexed fields, read-only state, etc.)
`stats://vault`	Vault statistics (document count, chunk count, embedding count, etc.)
`tags://vault`	All frontmatter tag values grouped by indexed field
`tags://vault/{field}`	Tag values for a specific indexed frontmatter field (template)
`folders://vault`	All folder paths in the vault
`toc://vault/{path}`	Table of contents (heading outline) for a specific document (template)
`similar://vault/{path}`	Top 10 semantically similar notes for a document (template)
`recent://vault`	20 most recently modified notes with ISO timestamps
`ui://vault/app.html`	Interactive vault explorer SPA for MCP Apps clients

Prompts

Prompt templates guide the LLM through multi-step workflows using the vault tools.

Prompt	Parameters	Description
`summarize`	`path`	Read a document and produce a structured summary with key themes and takeaways
`research`	`topic`	Search for a topic, synthesize findings, and create a new note at `research/{topic}.md`
`discuss`	`path`	Analyze a document and suggest improvements using `edit` (not `write`)
`create_from_template`	`template_name` (optional)	Discover templates (if needed), read a template, gather user values, and write a new note
`related`	`path`	Find related notes via search and suggest cross-references as markdown links
`compare`	`path1`, `path2`	Read two documents and produce a side-by-side comparison
`propose-links`	`scope` (optional), `per_note_limit` (optional)	Scan a candidate set of notes (a folder, `recent`, or `all`), propose meaningful links between semantically-close notes that aren't already connected, and write them on confirmation

Write prompts (research, discuss, create_from_template, propose-links) are only available when MARKDOWN_VAULT_MCP_READ_ONLY=false.

Templates are regular markdown files. If placeholder template text pollutes search results, add your templates folder to MARKDOWN_VAULT_MCP_EXCLUDE (for example _templates/**).

User-defined prompts

Mount a directory of .md prompt files to override or extend the built-in prompts. Set MARKDOWN_VAULT_MCP_PROMPTS_FOLDER to the path. Each file's frontmatter defines description, arguments (a list of objects, each with name, description, and required fields), and optional tags. A user prompt with the same name as a built-in replaces it.

For a complete example — including Zettelkasten capture, development, and review prompts — see the Zettelkasten guide. For an alternative action-oriented workflow — Projects, Areas, Resources, Archive with triage, kickoff, and weekly review prompts — see the PARA guide.

MCP Apps

The server ships four browser-based views that MCP clients supporting the MCP Apps protocol can render inline or in fullscreen. They are delivered as a single HTML resource at ui://vault/app.html and registered using visibility="app" so they appear only in supporting clients and do not clutter the standard tool list. See the MCP Apps guide for details.

View	Description
Context Card	Displays a note dossier (backlinks, outlinks, similar notes, tags) for the note currently in focus
Graph Explorer	Interactive force-directed link graph of the vault, powered by vis-network
Vault Browser	Searchable, filterable file tree for navigating the vault without issuing tool calls
Note Preview	Full-width markdown preview with a Contents popover, collapsible frontmatter properties and tags, copy-markdown / copy-vault-link controls, and a "Send to Claude" button

The two primary tools exposed to MCP Apps clients are:

Tool	Description
`browse_vault`	Returns the vault tree structure for the Vault Browser view
`show_context`	Returns the full context dossier for a given note path (used by the Context Card view)

Domain configuration: MCP Apps iframes are sandboxed to a specific Claude app domain. The domain is auto-computed from MARKDOWN_VAULT_MCP_BASE_URL. Override with MARKDOWN_VAULT_MCP_APP_DOMAIN if your deployment is hosted on a custom domain or behind a proxy that changes the apparent hostname.

Vendored dependencies (JavaScript libraries bundled at build time, no runtime CDN): vis-network (graph rendering), marked.js (markdown rendering), DOMPurify (XSS sanitization), ext-apps SDK (MCP Apps lifecycle). The one runtime network dependency is web fonts (Newsreader, Public Sans, IBM Plex Mono), loaded from Google Fonts with system-font fallbacks.

One-Time Transfer Links

create_download_link and create_upload_link mint short-lived capability URLs so vault files can move to a browser or another service without inflating the LLM context window. The token embedded in the URL is the only credential — no Authorization header is required on the /transfer/{token} route.

code

# Download a vault file
create_download_link(path="reports/q1.pdf", ttl_seconds=600)
# → {"url": "https://mcp.example.com/transfer/<token>", ...}
curl "https://mcp.example.com/transfer/<token>" -o q1.pdf

# Upload a file to the vault
create_upload_link(path="assets/new-diagram.png")
# → {"url": "https://mcp.example.com/transfer/<token>", ...}
curl -X POST --data-binary @new-diagram.png "https://mcp.example.com/transfer/<token>"

Each token is consumed on its first successful use. A failed or interrupted transfer does not burn the token — retry is permitted until the TTL expires.

Requirements: HTTP or SSE transport; MARKDOWN_VAULT_MCP_BASE_URL set. See the transfer links guide for the full walkthrough and security model.

Variable	Default	Description
`MARKDOWN_VAULT_MCP_TRANSFER_TTL_DEFAULT_S`	`3600`	Default token lifetime (seconds) when the caller omits `ttl_seconds`; clamped to the max below.
`MARKDOWN_VAULT_MCP_TRANSFER_TTL_MAX_S`	`86400`	Maximum permitted TTL; any larger `ttl_seconds` is silently clamped to this ceiling.
`MARKDOWN_VAULT_MCP_TRANSFER_MAX_UPLOAD_BYTES`	`104857600` (100 MiB)	Per-upload size cap; requests whose body exceeds it are rejected with HTTP 413.

Attachments

In addition to Markdown notes, the server can read, write, delete, rename, and list non-markdown files (PDFs, images, spreadsheets, etc.). All existing tools are overloaded — no new tool names.

How it works

Path dispatch is extension-based: a path ending in .md is treated as a note; any other path is treated as an attachment if the extension is in the allowlist. The kind field on returned objects distinguishes the two: "note" or "attachment".

Reading attachments

read returns base64-encoded content for binary attachments:

json

{
  "path": "assets/diagram.pdf",
  "mime_type": "application/pdf",
  "size_bytes": 12345,
  "content_base64": "<base64 string>",
  "modified_at": 1741564800.0
}

Writing attachments

write accepts a content_base64 parameter for binary content:

json

{ "path": "assets/diagram.pdf", "content_base64": "<base64 string>" }

Listing attachments

list_documents with include_attachments=true returns both notes and attachments:

json

[
  { "path": "notes/intro.md", "kind": "note", "title": "Intro", "folder": "notes", "frontmatter": {}, "modified_at": 1741564800.0 },
  { "path": "assets/diagram.pdf", "kind": "attachment", "folder": "assets", "mime_type": "application/pdf", "size_bytes": 12345, "modified_at": 1741564800.0 }
]

Default allowed extensions

pdf, docx, xlsx, pptx, odt, ods, odp, png, jpg, jpeg, gif, webp, svg, bmp, tiff, zip, tar, gz, mp3, mp4, wav, ogg, txt, csv, tsv, json, yaml, toml, xml, html, css, js, ts

Override with MARKDOWN_VAULT_MCP_ATTACHMENT_EXTENSIONS. Use * to allow all non-.md files.

Hidden directories: Attachments inside hidden directories (.git/, .obsidian/, .markdown_vault_mcp/, etc.) are never listed, regardless of extension settings. MARKDOWN_VAULT_MCP_EXCLUDE patterns are also applied to attachments.

Authentication

The server supports four auth modes:

Multi-auth — both bearer token and OIDC configured; either credential accepted (e.g. Claude web via OIDC + Claude Code via bearer token on the same instance)
Bearer token — set MARKDOWN_VAULT_MCP_BEARER_TOKEN to a secret string
OIDC — full OAuth 2.1 flow via OIDC_CONFIG_URL, OIDC_CLIENT_ID, OIDC_CLIENT_SECRET, and BASE_URL
No auth — server accepts all connections (default)

Auth requires --transport http (or sse). It has no effect with --transport stdio.

For setup instructions, troubleshooting, and provider-specific guides, see the Authentication guide.

Development

bash

git clone https://github.com/pvliesdonk/markdown-vault-mcp.git
cd markdown-vault-mcp
uv sync --all-extras --all-groups

# Run tests
uv run python -m pytest tests/ -x -q

# Lint and format
uv run ruff check src/ tests/
uv run ruff format src/ tests/

# Type check
uv run mypy src/ tests/

GitHub secrets

CI workflows reference three repository secrets. Configure them via Settings → Secrets and variables → Actions or with gh secret set:

Secret	Used by	How to generate
`RELEASE_TOKEN`	`release.yml`, `copier-update.yml`	Fine-grained PAT at https://github.com/settings/personal-access-tokens/new with `contents: write` and `pull_requests: write` (the `copier-update` cron opens PRs). Scoped to this repo.
`CODECOV_TOKEN`	`ci.yml`	https://codecov.io — sign in with GitHub, add the repo, copy the upload token from the repo settings page.
`CLAUDE_CODE_OAUTH_TOKEN`	`claude.yml`, `claude-code-review.yml`	Run `claude setup-token` locally and paste the result.

GITHUB_TOKEN is auto-provided — no action needed.

Troubleshooting

Moving a scaffolded project

uv sync creates .venv/bin/* scripts with absolute shebangs pointing at the venv Python. If you move the repo (mv /old/path /new/path), uv run pytest fails with ModuleNotFoundError because the stale shebang resolves to a different interpreter than the venv's site-packages.

Fix:

bash

rm -rf .venv
uv sync --all-extras --all-groups

uv run python -m pytest also works as a one-shot workaround.

`uv.lock` refresh after `copier update`

When copier update introduces new dependencies, CI runs uv sync --frozen which fails against a stale lockfile. Run uv lock locally and commit the refreshed uv.lock alongside accepting the copier-update PR.

Upgrading from earlier versions

v2.0.0 (issue #469): search, get_similar, and get_context.similar now return grouped results. Each file appears once with a sections list; the flat content, heading, and score fields have moved inside each SectionHit. Library consumers must update iteration:
python
```
# Before: result.content, result.heading
# After:  result.sections[0].content, result.sections[0].heading
```
MARKDOWN_VAULT_MCP_CHUNKS_PER_FILE replaces MARKDOWN_VAULT_MCP_CHUNKS_PER_DOC. SimilarItem is removed; use GroupedResult (also re-exported at the package level).
MARKDOWN_VAULT_MCP_MAX_ATTACHMENT_SIZE_MB default lowered from 10 MB to 1 MB. Most LLM contexts can't survive a 10 MB base64-encoded attachment; the old default was a silent context-blow-up. If you have non-LLM consumers (scripts, CI) that need the old behaviour, set MARKDOWN_VAULT_MCP_MAX_ATTACHMENT_SIZE_MB=10 explicitly.
MARKDOWN_VAULT_MCP_MAX_NOTE_READ_BYTES is a new env var (default 256 KB). Whole-document .md reads above this raise ValueError. Partial reads via read(path, section=heading) bypass the cap.

License

MIT

Install

Configuration

Environment variables

MARKDOWN_VAULT_MCP_SOURCE_DIRrequired

Absolute path to the markdown vault directory

MARKDOWN_VAULT_MCP_READ_ONLYdefault true

Disable write tools

FASTMCP_LOG_LEVELdefault INFO

Log level for FastMCP internals; app loggers default to INFO, -v overrides both to DEBUG

MARKDOWN_VAULT_MCP_KV_STORE_URLdefault file:///data/state

Unified key-value backend for HTTP session persistence (file:///path or memory://). Legacy alias: MARKDOWN_VAULT_MCP_EVENT_STORE_URL

MARKDOWN_VAULT_MCP_SERVER_NAMEdefault markdown-vault-mcp

MCP server name shown to clients

MARKDOWN_VAULT_MCP_STATE_PATH

Directory for index and embeddings state files

MARKDOWN_VAULT_MCP_INDEX_PATH

Path to the FTS5 SQLite index file

MARKDOWN_VAULT_MCP_EMBEDDINGS_PATH

Path to the numpy embeddings file

MARKDOWN_VAULT_MCP_INDEXED_FIELDS

Comma-separated frontmatter fields to index for search

MARKDOWN_VAULT_MCP_REQUIRED_FIELDS

Comma-separated frontmatter fields required on every document

MARKDOWN_VAULT_MCP_EXCLUDE

Comma-separated glob patterns to exclude from indexing

MARKDOWN_VAULT_MCP_EMBEDDING_PROVIDER

Embedding provider to use

OPENAI_API_KEYsecret

OpenAI API key (required when MARKDOWN_VAULT_MCP_EMBEDDING_PROVIDER=openai)

OPENAI_BASE_URLdefault https://api.openai.com/v1

OpenAI-compatible API base URL (e.g. SiliconFlow, Together, internal gateways); also accepts MARKDOWN_VAULT_MCP_OPENAI_BASE_URL

OPENAI_EMBEDDING_MODELdefault text-embedding-3-small

OpenAI-compatible embedding model name; also accepts MARKDOWN_VAULT_MCP_OPENAI_EMBEDDING_MODEL

MARKDOWN_VAULT_MCP_OLLAMA_MODELdefault nomic-embed-text

Ollama embedding model name

MARKDOWN_VAULT_MCP_OLLAMA_CPU_ONLYdefault false

Force CPU-only inference for Ollama

OLLAMA_HOSTdefault http://localhost:11434

Ollama server base URL

MARKDOWN_VAULT_MCP_GIT_TOKENsecret

Git authentication token for push/pull

MARKDOWN_VAULT_MCP_GIT_REPO_URL

Remote git repository URL for managed mode

MARKDOWN_VAULT_MCP_GIT_USERNAMEdefault x-access-token

Git username for token auth

MARKDOWN_VAULT_MCP_GIT_COMMIT_NAMEdefault markdown-vault-mcp

Git committer name

MARKDOWN_VAULT_MCP_GIT_COMMIT_EMAILdefault noreply@markdown-vault-mcp

Git committer email

MARKDOWN_VAULT_MCP_GIT_PUSH_DELAY_Sdefault 30

Seconds to wait before pushing (batches writes)

MARKDOWN_VAULT_MCP_GIT_LFSdefault true

Enable Git LFS support

MARKDOWN_VAULT_MCP_GIT_PULL_INTERVAL_Sdefault 600

Seconds between periodic git pulls (0 to disable)

MARKDOWN_VAULT_MCP_ATTACHMENT_EXTENSIONS

Comma-separated allowed attachment extensions, or * for all

MARKDOWN_VAULT_MCP_MAX_ATTACHMENT_SIZE_MBdefault 10

Maximum attachment size in MB (0 for unlimited)

MARKDOWN_VAULT_MCP_TEMPLATES_FOLDERdefault _templates

Folder name for note templates within the vault

MARKDOWN_VAULT_MCP_PROMPTS_FOLDER

Path to user-defined MCP prompt templates

MARKDOWN_VAULT_MCP_BEARER_TOKENsecret

Bearer token for authentication

MARKDOWN_VAULT_MCP_AUTH_MODE

OIDC auth mode: 'remote' (JWKS validation) or 'oidc-proxy' (OAuth proxy). Auto-detected if not set.

MARKDOWN_VAULT_MCP_BASE_URL

Public base URL of this server (required for OIDC)

MARKDOWN_VAULT_MCP_OIDC_CONFIG_URL

OIDC discovery endpoint URL

MARKDOWN_VAULT_MCP_OIDC_CLIENT_ID

OIDC client ID

MARKDOWN_VAULT_MCP_OIDC_CLIENT_SECRETsecret

OIDC client secret

MARKDOWN_VAULT_MCP_OIDC_JWT_SIGNING_KEYsecret

Signing key for OIDC session JWTs (critical on Linux/Docker)

MARKDOWN_VAULT_MCP_OIDC_AUDIENCE

Expected OIDC token audience

MARKDOWN_VAULT_MCP_OIDC_REQUIRED_SCOPESdefault openid

Space-separated required OIDC scopes

MARKDOWN_VAULT_MCP_OIDC_VERIFY_ACCESS_TOKENdefault false

Verify access token JWT instead of id_token

MARKDOWN_VAULT_MCP_APP_DOMAIN

Override Claude app domain for MCP Apps iframe sandboxing

PUIDdefault 1000

Run as this UID (Docker entrypoint)

PGIDdefault 1000

Run as this GID (Docker entrypoint)

Arguments

--portdefault 8000

claude_desktop_config.json

{
  "mcpServers": {
    "markdown-vault-mcp": {
      "command": "uvx",
      "args": [
        "markdown-vault-mcp"
      ],
      "env": {
        "MARKDOWN_VAULT_MCP_SOURCE_DIR": "<YOUR_MARKDOWN_VAULT_MCP_SOURCE_DIR>",
        "MARKDOWN_VAULT_MCP_READ_ONLY": "true",
        "FASTMCP_LOG_LEVEL": "INFO",
        "MARKDOWN_VAULT_MCP_KV_STORE_URL": "file:///data/state",
        "MARKDOWN_VAULT_MCP_SERVER_NAME": "markdown-vault-mcp",
        "MARKDOWN_VAULT_MCP_STATE_PATH": "<YOUR_MARKDOWN_VAULT_MCP_STATE_PATH>",
        "MARKDOWN_VAULT_MCP_INDEX_PATH": "<YOUR_MARKDOWN_VAULT_MCP_INDEX_PATH>",
        "MARKDOWN_VAULT_MCP_EMBEDDINGS_PATH": "<YOUR_MARKDOWN_VAULT_MCP_EMBEDDINGS_PATH>",
        "MARKDOWN_VAULT_MCP_INDEXED_FIELDS": "<YOUR_MARKDOWN_VAULT_MCP_INDEXED_FIELDS>",
        "MARKDOWN_VAULT_MCP_REQUIRED_FIELDS": "<YOUR_MARKDOWN_VAULT_MCP_REQUIRED_FIELDS>",
        "MARKDOWN_VAULT_MCP_EXCLUDE": "<YOUR_MARKDOWN_VAULT_MCP_EXCLUDE>",
        "MARKDOWN_VAULT_MCP_EMBEDDING_PROVIDER": "<YOUR_MARKDOWN_VAULT_MCP_EMBEDDING_PROVIDER>",
        "OPENAI_API_KEY": "<YOUR_OPENAI_API_KEY>",
        "OPENAI_BASE_URL": "https://api.openai.com/v1",
        "OPENAI_EMBEDDING_MODEL": "text-embedding-3-small",
        "MARKDOWN_VAULT_MCP_OLLAMA_MODEL": "nomic-embed-text",
        "MARKDOWN_VAULT_MCP_OLLAMA_CPU_ONLY": "false",
        "OLLAMA_HOST": "http://localhost:11434",
        "MARKDOWN_VAULT_MCP_GIT_TOKEN": "<YOUR_MARKDOWN_VAULT_MCP_GIT_TOKEN>",
        "MARKDOWN_VAULT_MCP_GIT_REPO_URL": "<YOUR_MARKDOWN_VAULT_MCP_GIT_REPO_URL>",
        "MARKDOWN_VAULT_MCP_GIT_USERNAME": "x-access-token",
        "MARKDOWN_VAULT_MCP_GIT_COMMIT_NAME": "markdown-vault-mcp",
        "MARKDOWN_VAULT_MCP_GIT_COMMIT_EMAIL": "noreply@markdown-vault-mcp",
        "MARKDOWN_VAULT_MCP_GIT_PUSH_DELAY_S": "30",
        "MARKDOWN_VAULT_MCP_GIT_LFS": "true",
        "MARKDOWN_VAULT_MCP_GIT_PULL_INTERVAL_S": "600",
        "MARKDOWN_VAULT_MCP_ATTACHMENT_EXTENSIONS": "<YOUR_MARKDOWN_VAULT_MCP_ATTACHMENT_EXTENSIONS>",
        "MARKDOWN_VAULT_MCP_MAX_ATTACHMENT_SIZE_MB": "10",
        "MARKDOWN_VAULT_MCP_TEMPLATES_FOLDER": "_templates",
        "MARKDOWN_VAULT_MCP_PROMPTS_FOLDER": "<YOUR_MARKDOWN_VAULT_MCP_PROMPTS_FOLDER>",
        "MARKDOWN_VAULT_MCP_BEARER_TOKEN": "<YOUR_MARKDOWN_VAULT_MCP_BEARER_TOKEN>",
        "MARKDOWN_VAULT_MCP_AUTH_MODE": "<YOUR_MARKDOWN_VAULT_MCP_AUTH_MODE>",
        "MARKDOWN_VAULT_MCP_BASE_URL": "<YOUR_MARKDOWN_VAULT_MCP_BASE_URL>",
        "MARKDOWN_VAULT_MCP_OIDC_CONFIG_URL": "<YOUR_MARKDOWN_VAULT_MCP_OIDC_CONFIG_URL>",
        "MARKDOWN_VAULT_MCP_OIDC_CLIENT_ID": "<YOUR_MARKDOWN_VAULT_MCP_OIDC_CLIENT_ID>",
        "MARKDOWN_VAULT_MCP_OIDC_CLIENT_SECRET": "<YOUR_MARKDOWN_VAULT_MCP_OIDC_CLIENT_SECRET>",
        "MARKDOWN_VAULT_MCP_OIDC_JWT_SIGNING_KEY": "<YOUR_MARKDOWN_VAULT_MCP_OIDC_JWT_SIGNING_KEY>",
        "MARKDOWN_VAULT_MCP_OIDC_AUDIENCE": "<YOUR_MARKDOWN_VAULT_MCP_OIDC_AUDIENCE>",
        "MARKDOWN_VAULT_MCP_OIDC_REQUIRED_SCOPES": "openid",
        "MARKDOWN_VAULT_MCP_OIDC_VERIFY_ACCESS_TOKEN": "false",
        "MARKDOWN_VAULT_MCP_APP_DOMAIN": "<YOUR_MARKDOWN_VAULT_MCP_APP_DOMAIN>"
      }
    }
  }
}

Topics

markdown-vault-mcp

Features

What you can do with it

Installation

From PyPI

From source

Docker

Linux packages (.deb / .rpm)

Claude Desktop (.mcpb bundle)

Claude Code plugin

Quick Start

As a library

As an MCP server

With Docker Compose

Example env files

Server info

Configuration

Core

Server identity

Search and embeddings

Git integration

File Watcher

Attachments

Bearer token authentication

OIDC authentication

CLI Reference

serve

Reverse Proxy Subpath Mounts

index

search

reindex

MCP Tools

Resources

Prompts

User-defined prompts

MCP Apps

One-Time Transfer Links

Attachments

How it works

Reading attachments

Writing attachments

Listing attachments

Default allowed extensions

Authentication

Development

GitHub secrets

Troubleshooting

Moving a scaffolded project

uv.lock refresh after copier update

Upgrading from earlier versions

License

Install

Configuration

`serve`

`index`

`search`

`reindex`

`uv.lock` refresh after `copier update`