Back to Browse

Markdown Vault MCP Server

by User
SecurityLow Risk10.0Local
Free

Generic markdown vault MCP with hybrid search

About

Generic markdown vault MCP with hybrid search

Security Report

10.0
Low Risk10.0Low Risk

Valid MCP server (1 strong, 1 medium validity signals). No known CVEs in dependencies. Package registry verified. Imported from the Official MCP Registry. Trust signals: trusted author (5/5 approved).

4 files analyzed · 1 issue found

Security scores are indicators to help you make informed decisions, not guarantees. Always review permissions before connecting any MCP server.

What You'll Need

Set these up before or after installing:

Persistent-state backend URL shared by every pvl-core subsystem that needs state. `memory://` is in-process and lost on restart; `file:///path` persists on one server; `redis://`, `dynamodb://` and `mongodb://` each need their matching extra. When unset, defaults to `file:///data/state` (the volume family Docker images mount), or to `memory://` (with a warning) on a host where that directory is not usable.Optional

Environment variable: MARKDOWN_VAULT_MCP_KV_STORE_URL

Comma-separated explicit tool names this instance exposes; every other tool is hidden from listings and cannot be invoked. Names matching no registered tool are inert. Mutually exclusive with `tools_deny`. Takes effect through `apply_tool_visibility`.Optional

Environment variable: MARKDOWN_VAULT_MCP_TOOLS_ALLOW

Comma-separated explicit tool names hidden from this instance (absent from listings, cannot be invoked). Names matching no registered tool are inert. Mutually exclusive with `tools_allow`. Takes effect through `apply_tool_visibility`.Optional

Environment variable: MARKDOWN_VAULT_MCP_TOOLS_DENY

Rename this server instance; defaults to the project name.Optional

Environment variable: MARKDOWN_VAULT_MCP_SERVER_NAME

Concise routing context that distinguishes this deployment's material or responsibility.Optional

Environment variable: MARKDOWN_VAULT_MCP_INSTANCE_DESCRIPTION

Deployment-specific behavioral policy added to the generated MCP instructions.Optional

Environment variable: MARKDOWN_VAULT_MCP_INSTRUCTIONS_EXTRA

Legacy: replaces all generated MCP instructions (deprecated; use _INSTANCE_DESCRIPTION for routing and _INSTRUCTIONS_EXTRA for policy).Optional

Environment variable: MARKDOWN_VAULT_MCP_INSTRUCTIONS

Log level for every logger in the process, FastMCP's included (DEBUG / INFO / WARNING / ERROR / CRITICAL). The -v CLI flag overrides to DEBUG. The unprefixed FASTMCP_LOG_LEVEL still works for one major version and logs a deprecation warning.Optional

Environment variable: MARKDOWN_VAULT_MCP_LOG_LEVEL

Log rendering. rich is one colour event key=value line per record, for a terminal; json is one JSON object per record, for a collector. Unset picks rich when stderr is a terminal and json everywhere else, so a container or journald gets JSON with no configuration.Optional

Environment variable: MARKDOWN_VAULT_MCP_LOG_FORMAT

Ollama server URL for the ollama embedding provider. Bare (not MARKDOWN_VAULT_MCP_-prefixed), matching the Ollama ecosystem convention.Optional

Environment variable: OLLAMA_HOST

OpenAI API key for the openai embedding provider, and the fallback key for the summarize tool when MARKDOWN_VAULT_MCP_SUMMARIZE_OPENAI_API_KEY is unset. Bare (not MARKDOWN_VAULT_MCP_-prefixed), matching the OpenAI ecosystem convention.Required

Environment variable: OPENAI_API_KEY

Voyage AI API key for the voyage embedding provider. Bare (not MARKDOWN_VAULT_MCP_-prefixed), matching the OPENAI_API_KEY / OLLAMA_HOST convention. Setting it never auto-selects the provider; choose it explicitly with MARKDOWN_VAULT_MCP_EMBEDDING_PROVIDER=voyage.Required

Environment variable: VOYAGE_API_KEY

Bare fallback for MARKDOWN_VAULT_MCP_OPENAI_BASE_URL (embeddings). For the summarize tool it only routes traffic when an API key already enables the feature; it never enables summarize by itself.Optional

Environment variable: OPENAI_BASE_URL

Bare fallback for MARKDOWN_VAULT_MCP_OPENAI_EMBEDDING_MODEL.Optional

Environment variable: OPENAI_EMBEDDING_MODEL

Maximum seconds an index-backed tool or resource waits for the FTS index to become queryable during a cold-start background build before raising IndexUnavailableError(reason="timeout"). Increase for large vaults.Optional

Environment variable: MARKDOWN_VAULT_MCP_BUILD_TIMEOUT_S

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 and reports index_stale=true in the response _meta.Optional

Environment variable: MARKDOWN_VAULT_MCP_DRAIN_TIMEOUT_S

Path to the markdown vault directory. When it does not exist, or the server cannot access it, the server starts but every tool fails with a message saying which until it is fixed (managed git mode clones into it). Symbolic links inside the vault are followed on Python 3.13+.Optional

Environment variable: MARKDOWN_VAULT_MCP_SOURCE_DIR

Set to true to hide the write tools (write, edit, append, delete, rename, move_folder, fetch, git_sync, the okf_* tools, create_upload_link) and serve a search-only vault.Optional

Environment variable: MARKDOWN_VAULT_MCP_READ_ONLY

Refuse a write that would overwrite an existing file when no if_match etag is supplied. Deliberate replacement still works: read the file first, then pass if_match. Unaffected: edit, append, delete, rename. Set to false to allow blind overwrites.Optional

Environment variable: MARKDOWN_VAULT_MCP_WRITE_PROTECT_EXISTING

Set to true to have write, edit and append list, under unresolved_links, the target of each link the call added that get_broken_links reports. Links the note already held are left out. Off by default, leaving those responses unchanged.Optional

Environment variable: MARKDOWN_VAULT_MCP_REPORT_UNRESOLVED_LINKS

Hide the MCP Apps UI tools (browse_vault, show_context) from the tool listing for clients that do not render MCP Apps panels.Optional

Environment variable: MARKDOWN_VAULT_MCP_DISABLE_APPS_UI

Path to the SQLite FTS5 index file; unset keeps the index in memory. Set it for persistence across restarts.Optional

Environment variable: MARKDOWN_VAULT_MCP_INDEX_PATH

Path to the change-tracking state file. Defaults to INDEX_PATH plus .state.json (index.db.state.json beside index.db); without INDEX_PATH the state is kept in memory. Never written into the vault by default.Optional

Environment variable: MARKDOWN_VAULT_MCP_STATE_PATH

Base path for the embeddings files. Defaults beside INDEX_PATH (index-db-embeddings.npy and .json beside index.db); without INDEX_PATH the vectors are kept in memory and rebuilt at each start. Setting it also lets the provider be auto-detected.Optional

Environment variable: MARKDOWN_VAULT_MCP_EMBEDDINGS_PATH

Comma-separated frontmatter fields promoted to the tag index for structured filtering. Changing it cold-rebuilds the index once on next startup; SEARCHABLE_FIELDS inherits this value when unset.Optional

Environment variable: MARKDOWN_VAULT_MCP_INDEXED_FIELDS

Comma-separated frontmatter fields required on every document; documents missing any are excluded from the index.Optional

Environment variable: MARKDOWN_VAULT_MCP_REQUIRED_FIELDS

Comma-separated glob patterns excluded from scanning, e.g. .obsidian/**,.trash/**.Optional

Environment variable: MARKDOWN_VAULT_MCP_EXCLUDE

Frontmatter field used as the document title (falls back to title, the first H1, then the filename). Changing it cold-rebuilds the index once on next startup.Optional

Environment variable: MARKDOWN_VAULT_MCP_TITLE_FIELD

Comma-separated frontmatter fields whose text values become keyword-searchable and enrich first-chunk embeddings. Inherits INDEXED_FIELDS when unset; the sentinel none means filterable but not searchable. Changing it cold-rebuilds the index and re-embeds once on next startup.Optional

Environment variable: MARKDOWN_VAULT_MCP_SEARCHABLE_FIELDS

Relative folder where note templates live (used by the create_from_template prompt).Optional

Environment variable: MARKDOWN_VAULT_MCP_TEMPLATES_FOLDER

Directory of .md prompt files that extend or override built-in prompts; a relative path is resolved against SOURCE_DIR.Optional

Environment variable: MARKDOWN_VAULT_MCP_PROMPTS_FOLDER

Filename of the per-folder conventions files surfaced to clients at write time (bare .md filename without glob characters). Set to none to disable folder conventions.Optional

Environment variable: MARKDOWN_VAULT_MCP_CONVENTIONS_FILE

OKF (Open Knowledge Format) read semantics. With auto (the default), read annotations switch on when the vault declares an OKF version in its root index.md. Use off to disable OKF semantics entirely, or on to force them for an undeclared vault. Annotations are read-only; write behavior is never affected.Optional

Environment variable: MARKDOWN_VAULT_MCP_OKF_MODE

OKF (Open Knowledge Format) enforced write layer. When true on an OKF-active vault, the server stamps generated provenance on each write and clears any verified attestation when a note's content changes. It also keeps each written folder's log.md and index.md current, and exposes the okf_verify tool. Requires OKF_MODE to be auto or on (a true value with OKF_MODE=off is a config error). Off by default.Optional

Environment variable: MARKDOWN_VAULT_MCP_OKF_WRITE

How the okf_verify tool attributes a human review. This applies only when OKF_WRITE is on, which gates the tool. With elicit (the default), okf_verify asks the human to confirm the review through an MCP elicitation, then records the attestation only on an affirmative reply. It fails closed when the client cannot elicit or the human declines, so a model holding the human's token cannot self-attest. Set trust-auth instead to attribute to a token's sub claim with no confirmation; it rejects static bearer credentials and other client-ID-only identities. This is safe only when the sole caller is a human-driven UI. Set off to hide the tool, leaving attestation to external tooling. A non-default value with OKF_WRITE off is a config error.Optional

Environment variable: MARKDOWN_VAULT_MCP_OKF_VERIFY

Comma-separated allowed attachment extensions (e.g. pdf,png,jpg); case and a leading dot are ignored, so PDF and .pdf name the same type. Use * to allow every non-markdown file. Unset selects the built-in allowlist. A link whose target has a listed extension is not part of the link graph; changing the list rebuilds the index once.Optional

Environment variable: MARKDOWN_VAULT_MCP_ATTACHMENT_EXTENSIONS

Maximum attachment size in MB returned by read / accepted by write; 0 disables the limit.Optional

Environment variable: MARKDOWN_VAULT_MCP_MAX_ATTACHMENT_SIZE_MB

Maximum bytes returned by a full-document read of a note; use `read(path, section=…)` for partial reads. 0 disables the limit.Optional

Environment variable: MARKDOWN_VAULT_MCP_MAX_NOTE_READ_BYTES

Mode used when a search call omits 'mode': auto, keyword, semantic, or hybrid. The default 'auto' picks hybrid when embeddings are configured and keyword when they are not. Pin 'keyword' to keep unqualified searches off the embedding provider (each hybrid or semantic search embeds the query, which costs an API call on a metered provider). A configured semantic/hybrid default also degrades to keyword without embeddings, so no setting can make a vault unsearchable; an explicit mode= argument is never downgraded.Optional

Environment variable: MARKDOWN_VAULT_MCP_DEFAULT_SEARCH_MODE

Maximum chunks returned per document in search results.Optional

Environment variable: MARKDOWN_VAULT_MCP_CHUNKS_PER_FILE

Width of the snippet window (words) in search results; 0 returns full chunk content.Optional

Environment variable: MARKDOWN_VAULT_MCP_SNIPPET_WORDS

Down-weights longer chunks in ranking: score / (1 + alpha * log(chunk_count)).Optional

Environment variable: MARKDOWN_VAULT_MCP_LENGTH_DOWNWEIGHT_ALPHA

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 reindex applies a new value.Optional

Environment variable: MARKDOWN_VAULT_MCP_MAX_CHUNK_WORDS

Character cap enforced alongside MAX_CHUNK_WORDS to bound token-dense chunks. Unset derives min(1500, model context * 2.8). Set a positive value for an exact cap, or -1 to scale with the model's full context (can exhaust memory on long-context models). A reindex applies a new value.Optional

Environment variable: MARKDOWN_VAULT_MCP_MAX_CHUNK_CHARS

Words of overlap between adjacent budget-split fragments of the same heading section (0 disables). A reindex applies a new value.Optional

Environment variable: MARKDOWN_VAULT_MCP_CHUNK_OVERLAP_WORDS

Folder-prefix score multipliers (`prefix:weight` pairs, comma-separated, weights > 0) applied to all search modes; the deepest matching prefix wins (sessions:0.5 demotes sessions/**).Optional

Environment variable: MARKDOWN_VAULT_MCP_FOLDER_WEIGHTS

Per-column BM25 weights (`column:weight` pairs, comma-separated, weights >= 0) for keyword ranking. Columns: path, title, folder, heading, content, summary.Optional

Environment variable: MARKDOWN_VAULT_MCP_FTS_WEIGHTS

Embedding provider: openai, voyage, ollama, or fastembed; setting it turns on search by meaning. Unset auto-detects from the environment (never voyage), but only when EMBEDDINGS_PATH is set. Any OpenAI-compatible endpoint works with openai plus OPENAI_BASE_URL; see the embeddings guide.Optional

Environment variable: MARKDOWN_VAULT_MCP_EMBEDDING_PROVIDER

Ollama embedding model name.Optional

Environment variable: MARKDOWN_VAULT_MCP_OLLAMA_MODEL

Force Ollama to embed on CPU only.Optional

Environment variable: MARKDOWN_VAULT_MCP_OLLAMA_CPU_ONLY

Voyage AI embedding model name.Optional

Environment variable: MARKDOWN_VAULT_MCP_VOYAGE_MODEL

OpenAI-compatible API base URL for embeddings; the bare OPENAI_BASE_URL is honoured as a fallback.Optional

Environment variable: MARKDOWN_VAULT_MCP_OPENAI_BASE_URL

OpenAI-compatible embedding model name; the bare OPENAI_EMBEDDING_MODEL is honoured as a fallback.Optional

Environment variable: MARKDOWN_VAULT_MCP_OPENAI_EMBEDDING_MODEL

FastEmbed model name.Optional

Environment variable: MARKDOWN_VAULT_MCP_FASTEMBED_MODEL

FastEmbed model cache directory (in Docker, stored under /data/state/fastembed).Optional

Environment variable: MARKDOWN_VAULT_MCP_FASTEMBED_CACHE_DIR

Enrich embedding input with the note title, chunk heading, and (first chunk) searchable-field values. Flipping it re-embeds the whole vault once on next startup.Optional

Environment variable: MARKDOWN_VAULT_MCP_EMBED_CONTEXT

Per-request wall-clock budget in seconds for a single embedding HTTP call (OpenAI/Ollama). The local FastEmbed backend runs in-process with no network call and ignores this. CPU-only or large-model workloads may need 60-120 s; raise this if batches time out.Optional

Environment variable: MARKDOWN_VAULT_MCP_EMBED_TIMEOUT_S

Number of chunks sent per embedding request. Smaller batches shorten each request (useful under a tight timeout on slow models) at the cost of more round-trips.Optional

Environment variable: MARKDOWN_VAULT_MCP_EMBEDDING_BATCH_SIZE

Token/password for HTTPS git auth; remotes must be HTTPS when set.Required

Environment variable: MARKDOWN_VAULT_MCP_GIT_TOKEN

HTTPS remote URL for managed git mode: the server clones into an empty SOURCE_DIR on startup (or validates an existing origin) and enables the pull loop, auto-commit, and deferred push.Optional

Environment variable: MARKDOWN_VAULT_MCP_GIT_REPO_URL

Username for HTTPS git auth prompts (x-access-token for GitHub, oauth2 for GitLab, the account name for Bitbucket).Optional

Environment variable: MARKDOWN_VAULT_MCP_GIT_USERNAME

Seconds between git fetch + fast-forward update attempts; 0 disables periodic pull.Optional

Environment variable: MARKDOWN_VAULT_MCP_GIT_PULL_INTERVAL_S

Seconds of write-idle time before pushing; 0 pushes only on shutdown.Optional

Environment variable: MARKDOWN_VAULT_MCP_GIT_PUSH_DELAY_S

Git committer name for auto-commits, and the author name too unless an OIDC claim supplies one; set this in Docker where git config user.name is empty.Optional

Environment variable: MARKDOWN_VAULT_MCP_GIT_COMMIT_NAME

Git committer email for auto-commits, and the author email too unless an OIDC claim supplies one.Optional

Environment variable: MARKDOWN_VAULT_MCP_GIT_COMMIT_EMAIL

OIDC claim key used as the commit author name (e.g. name) when an OIDC token is present; the committer stays GIT_COMMIT_NAME. The claim is resolved when the tool call arrives and carried to the background commit, so it applies on every write. A configured claim the token does not carry is reported once at WARNING and the static identity is used.Optional

Environment variable: MARKDOWN_VAULT_MCP_GIT_COMMIT_NAME_CLAIM

OIDC claim key used as the commit author email (e.g. email) when an OIDC token is present; the committer stays GIT_COMMIT_EMAIL. Resolved and carried the same way as the name claim.Optional

Environment variable: MARKDOWN_VAULT_MCP_GIT_COMMIT_EMAIL_CLAIM

Run git lfs pull on startup to fetch LFS-tracked attachments; set to false for repos without LFS.Optional

Environment variable: MARKDOWN_VAULT_MCP_GIT_LFS

Watch the vault for external filesystem changes; auto-disabled when git pull is active or a webhook can deliver (HTTP/SSE transports only). Requires the file-watcher extra.Optional

Environment variable: MARKDOWN_VAULT_MCP_FILE_WATCHER

Seconds of quiet after the last filesystem event before reindexing.Optional

Environment variable: MARKDOWN_VAULT_MCP_FILE_WATCHER_DEBOUNCE_S

Keep the non-recursive watch on the vault root; set false to register zero source-dir-rooted FSEvents streams (avoids repeated macOS access prompts on a home-rooted vault) at the cost of root-level files relying on scans.Optional

Environment variable: MARKDOWN_VAULT_MCP_FILE_WATCHER_ROOT_FLOOR

Reconcile offline changes at startup by reindexing once the initial build completes. Set false on a large vault to start without paying a full filesystem scan per server start; changes made while no server was running are then invisible until a reindex runs (the reindex tool, or 'markdown-vault-mcp reindex'). Note that `index_stale` reports writer idleness, not agreement with disk, so it reads false while the index may still differ from the vault.Optional

Environment variable: MARKDOWN_VAULT_MCP_BOOT_REINDEX

Shared secret for the GitHub push-event webhook; when set, mounts POST /github-webhook on HTTP/SSE transports to trigger an immediate pull + reindex on push events.Required

Environment variable: MARKDOWN_VAULT_MCP_GITHUB_WEBHOOK_SECRET

Signing token for the GitLab push-event webhook (GitLab 19.0+); when set, mounts POST /gitlab-webhook on HTTP/SSE transports to trigger an immediate pull + reindex on push events. GitLab generates this value; copy the `whsec_` token it shows under Generate signing token rather than inventing one. Deliveries are authenticated by HMAC-SHA256 over the webhook id, timestamp and body, and a delivery older than 5 minutes is rejected.Required

Environment variable: MARKDOWN_VAULT_MCP_GITLAB_WEBHOOK_SIGNING_TOKEN

Secret token for the GitLab push-event webhook, GitLab's plain-text form and the only one below 19.0; also mounts POST /gitlab-webhook. It proves nothing about the body and cannot expire, so prefer the signing token where the GitLab version offers it. Setting both accepts either, which is how an existing webhook migrates.Required

Environment variable: MARKDOWN_VAULT_MCP_GITLAB_WEBHOOK_SECRET_TOKEN

Summarization backend (only openai is recognised). Unset auto-detects: the backend activates when credentials or an explicit endpoint are present.Optional

Environment variable: MARKDOWN_VAULT_MCP_SUMMARIZE_PROVIDER

API key for the OpenAI-compatible summarize endpoint; the bare OPENAI_API_KEY is honoured as a fallback. Unset works for keyless local endpoints (Ollama).Required

Environment variable: MARKDOWN_VAULT_MCP_SUMMARIZE_OPENAI_API_KEY

OpenAI-compatible endpoint base URL for the summarize tool; setting it enables the tool even without an API key. The bare OPENAI_BASE_URL routes traffic only when a key already enables the feature.Optional

Environment variable: MARKDOWN_VAULT_MCP_SUMMARIZE_OPENAI_BASE_URL

Chat model id used for summaries.Optional

Environment variable: MARKDOWN_VAULT_MCP_SUMMARIZE_OPENAI_MODEL

Upper bound on generated tokens per summarize call; on reasoning models this budget also covers internal reasoning tokens.Optional

Environment variable: MARKDOWN_VAULT_MCP_SUMMARIZE_MAX_TOKENS

Cap on the number of notes summarised in one call (subtree expansion truncates to this many).Optional

Environment variable: MARKDOWN_VAULT_MCP_SUMMARIZE_MAX_NOTES

Aggregate cap on note characters sent to the model in one call; excess is truncated with a flag on the result.Optional

Environment variable: MARKDOWN_VAULT_MCP_SUMMARIZE_MAX_INPUT_CHARS

Per-request wall-clock budget in seconds for a single summarize backend call; keep it below the MCP client's request timeout so the server-side error wins the race.Optional

Environment variable: MARKDOWN_VAULT_MCP_SUMMARIZE_TIMEOUT

Link lifetime in seconds when the caller requests no explicit TTL.Optional

Environment variable: MARKDOWN_VAULT_MCP_TRANSFER_TTL_DEFAULT_S

Ceiling in seconds a caller-requested link TTL is clamped to.Optional

Environment variable: MARKDOWN_VAULT_MCP_TRANSFER_TTL_MAX_S

Post-success grace window in seconds: a served token's TTL shrinks to this so a stalled transfer can retry within it.Optional

Environment variable: MARKDOWN_VAULT_MCP_TRANSFER_GRACE_TTL_S

Crashed-handler reclaim window in seconds for an in-flight reservation.Optional

Environment variable: MARKDOWN_VAULT_MCP_TRANSFER_LEASE_S

Maximum size in bytes of a single upload.Optional

Environment variable: MARKDOWN_VAULT_MCP_TRANSFER_MAX_UPLOAD_BYTES

Seconds a long-running tool call may run in the foreground before it is promoted to a background job and a job handle is returned instead.Optional

Environment variable: MARKDOWN_VAULT_MCP_JOBS_SOFT_DEADLINE_S

Seconds a background-job record (working or finished) is retained for polling before it expires from the store.Optional

Environment variable: MARKDOWN_VAULT_MCP_JOBS_RESULT_TTL_S

Maximum live background jobs per calling subject; further promotions are rejected until older records expire.Optional

Environment variable: MARKDOWN_VAULT_MCP_JOBS_MAX_PER_SUBJECT

Seconds SIGTERM may spend draining in-flight requests before the HTTP server exits. Keep it at or below the termination grace period the orchestrator allows. `0` drops in-flight requests immediately.Optional

Environment variable: MARKDOWN_VAULT_MCP_SHUTDOWN_GRACE_S

Public base URL of the deployed server, for example `https://mcp.example.com`. Required for OIDC. Also the fallback source of the MCP Apps domain when `app_domain` is unset.Optional

Environment variable: MARKDOWN_VAULT_MCP_BASE_URL

Single shared bearer token; enables bearer auth unless `bearer_tokens_file` is set, which takes precedence.Required

Environment variable: MARKDOWN_VAULT_MCP_BEARER_TOKEN

OIDC discovery document URL, for example `https://auth.example.com/.well-known/openid-configuration`.Optional

Environment variable: MARKDOWN_VAULT_MCP_OIDC_CONFIG_URL

OIDC client identifier registered with the provider.Optional

Environment variable: MARKDOWN_VAULT_MCP_OIDC_CLIENT_ID

OIDC client secret registered with the provider.Required

Environment variable: MARKDOWN_VAULT_MCP_OIDC_CLIENT_SECRET

Expected `aud` claim; tokens issued for another audience are rejected.Optional

Environment variable: MARKDOWN_VAULT_MCP_OIDC_AUDIENCE

Scopes a caller must present, space- or comma-separated. Defaults to `openid` in oidc-proxy mode.Optional

Environment variable: MARKDOWN_VAULT_MCP_OIDC_REQUIRED_SCOPES

Scopes advertised to MCP clients in protected-resource metadata, space- or comma-separated. Overrides the default `openid offline_access`; `oidc_required_scopes` is always added on top. Set this when the registered client is not permitted `offline_access`, or to have clients request extra claim scopes (such as `groups`) without also requiring them in every token.Optional

Environment variable: MARKDOWN_VAULT_MCP_OIDC_ADVERTISED_SCOPES

Signing key for issued tokens; used in oidc-proxy mode only. When unset, the key is derived deterministically from `oidc_client_secret`, so tokens survive a restart. Rotating that secret then invalidates every issued token. Set this explicitly to decouple token validity from secret rotation. Generate with `openssl rand -hex 32`.Required

Environment variable: MARKDOWN_VAULT_MCP_OIDC_JWT_SIGNING_KEY

Validate the access token instead of the id token.Optional

Environment variable: MARKDOWN_VAULT_MCP_OIDC_VERIFY_ACCESS_TOKEN

MCP Apps iframe domain, used for CSP sandboxing. Overrides the host derived from `base_url`.Optional

Environment variable: MARKDOWN_VAULT_MCP_APP_DOMAIN

Explicit auth-mode override, accepting `remote` or `oidc-proxy` (case- and whitespace-insensitive). When unset the mode is auto-detected from which auth variables are set; the override exists because having all four OIDC variables set is ambiguous between those two modes. Other values are ignored with a warning.Optional

Environment variable: MARKDOWN_VAULT_MCP_AUTH_MODE

Path to a TOML file mapping bearer tokens to subjects; overrides the single-token `bearer_token` mode.Optional

Environment variable: MARKDOWN_VAULT_MCP_BEARER_TOKENS_FILE

Subject assigned to the single-token bearer mode; ignored when `bearer_tokens_file` is set, since mapped mode carries per-token subjects.Optional

Environment variable: MARKDOWN_VAULT_MCP_BEARER_DEFAULT_SUBJECT

Mount path for the MCP endpoint; the health routes derive their prefix from it.Optional

Environment variable: MARKDOWN_VAULT_MCP_HTTP_PATH

How much the unauthenticated /health and /health/ready bodies say: status, standard (adds name, version and per-check verdicts), or full (adds redacted reasons; trusted networks only).Optional

Environment variable: MARKDOWN_VAULT_MCP_HEALTH_DETAIL

Run the server process as this UID; the container entrypoint reassigns ownership of writable paths to match.Optional

Environment variable: PUID

Run the server process as this GID; pair with PUID to match the owner of a mounted volume.Optional

Environment variable: PGID

How to Install

Add this to your MCP configuration file:

{
  "mcpServers": {
    "io-github-pvliesdonk-markdown-vault-mcp": {
      "env": {
        "MARKDOWN_VAULT_MCP_READ_ONLY": "your-markdown-vault-mcp-read-only-here",
        "MARKDOWN_VAULT_MCP_SOURCE_DIR": "your-markdown-vault-mcp-source-dir-here",
        "MARKDOWN_VAULT_MCP_BEARER_TOKEN": "your-markdown-vault-mcp-bearer-token-here",
        "MARKDOWN_VAULT_MCP_OIDC_CLIENT_ID": "your-markdown-vault-mcp-oidc-client-id-here",
        "MARKDOWN_VAULT_MCP_OIDC_CONFIG_URL": "your-markdown-vault-mcp-oidc-config-url-here",
        "MARKDOWN_VAULT_MCP_OIDC_CLIENT_SECRET": "your-markdown-vault-mcp-oidc-client-secret-here"
      },
      "args": [
        "markdown-vault-mcp"
      ],
      "command": "uvx"
    }
  }
}

Reviews

No reviews yet

Be the first to review this server!