# markdown-vault-mcp

> Generic markdown collection MCP server with FTS5 + semantic search

markdown-vault-mcp is a generic markdown collection MCP server with FTS5 full-text search, semantic search via embeddings, frontmatter-aware indexing, and incremental reindexing. It exposes 13 tools, 6 resources, and 6 prompts over the Model Context Protocol.


## Getting Started

- [Home](https://pvliesdonk.github.io/markdown-vault-mcp/index.md): Overview — features, quick start, and project links
- [Installation](https://pvliesdonk.github.io/markdown-vault-mcp/installation/index.md): Installation from PyPI, uv, source, or Docker
- [Configuration](https://pvliesdonk.github.io/markdown-vault-mcp/configuration/index.md): All environment variables with types and defaults

## Guides

- [Overview](https://pvliesdonk.github.io/markdown-vault-mcp/guides/index.md): Guide overview — which guide to read
- [Git Integration](https://pvliesdonk.github.io/markdown-vault-mcp/guides/git-integration/index.md): Git modes — managed, unmanaged (commit-only), and no-git
- [Claude Desktop](https://pvliesdonk.github.io/markdown-vault-mcp/guides/claude-desktop/index.md): Claude Desktop setup (read-only, git write, semantic search)
- [Docker](https://pvliesdonk.github.io/markdown-vault-mcp/guides/docker/index.md): Docker deployment (basic, git write, bearer token, OIDC)
- [Embeddings](https://pvliesdonk.github.io/markdown-vault-mcp/guides/embeddings/index.md): Embedding providers (Ollama, sentence-transformers, OpenAI)
- [Authentication](https://pvliesdonk.github.io/markdown-vault-mcp/guides/authentication/index.md): Authentication modes — bearer token, OIDC, and troubleshooting
- [OIDC Providers](https://pvliesdonk.github.io/markdown-vault-mcp/guides/oidc-providers/index.md): OIDC provider setup (Authelia, Keycloak, Google, GitHub via broker)
- [Obsidian Everywhere](https://pvliesdonk.github.io/markdown-vault-mcp/guides/obsidian-everywhere/index.md): Reference architecture for desktop + mobile + Claude on one vault
- [Zettelkasten](https://pvliesdonk.github.io/markdown-vault-mcp/guides/zettelkasten/index.md): Zettelkasten workflow (fleeting → literature → permanent notes, MOCs, graph navigation)
- [MCP Apps](https://pvliesdonk.github.io/markdown-vault-mcp/guides/mcp-apps/index.md): MCP Apps — Context Card, Graph Explorer, Vault Browser, and Note Preview views
- [Claude Code Plugin](https://pvliesdonk.github.io/markdown-vault-mcp/guides/claude-code-plugin/index.md): Claude Code plugin — install via /plugin marketplace

## MCP Interface

- [Tools](https://pvliesdonk.github.io/markdown-vault-mcp/tools/index.md): MCP tools with parameters and examples (search, read, write, link graph, MCP Apps)
- [Resources](https://pvliesdonk.github.io/markdown-vault-mcp/resources/index.md): MCP resources with URI patterns (config, stats, tags, folders, toc, similar, recent, ui)
- [Prompts](https://pvliesdonk.github.io/markdown-vault-mcp/prompts/index.md): All 6 MCP prompts with workflow descriptions

## Deployment

- [Overview](https://pvliesdonk.github.io/markdown-vault-mcp/deployment/index.md): Deployment overview
- [Docker](https://pvliesdonk.github.io/markdown-vault-mcp/deployment/docker/index.md): Docker Compose, Traefik, volumes, UID/GID
- [systemd](https://pvliesdonk.github.io/markdown-vault-mcp/deployment/systemd/index.md): systemd service — package install, manual install, security hardening
- [Claude Desktop](https://pvliesdonk.github.io/markdown-vault-mcp/deployment/claude-desktop/index.md): Claude Desktop configuration reference
- [OIDC Authentication](https://pvliesdonk.github.io/markdown-vault-mcp/deployment/oidc/index.md): OIDC authentication setup with Authelia

## Python API

- [Collection](https://pvliesdonk.github.io/markdown-vault-mcp/api/collection/index.md): Collection class API reference
- [Git Integration](https://pvliesdonk.github.io/markdown-vault-mcp/api/git/index.md): GitWriteStrategy API reference
- [Configuration](https://pvliesdonk.github.io/markdown-vault-mcp/api/config/index.md): Configuration loading API reference
- [Embedding Providers](https://pvliesdonk.github.io/markdown-vault-mcp/api/providers/index.md): Embedding provider API reference