Skip to main content
Glama
obsidian-vault-mcp

obsidian-vault-mcp

by JulioMCruz

Obsidian Vault MCP

HTTP-Model Context Protocol-Server, der KI-Agenten kontrollierten Zugriff auf einen lokalen Obsidian-Vault gewährt.

Entwickelt für Agent-Laufzeitumgebungen (Grok-Bots, Claude, OpenClaw, benutzerdefinierte MCP-Clients), die Markdown-Notizen auflisten, lesen, durchsuchen, erstellen, aktualisieren, umbenennen und sorgfältig löschen müssen.

Funktionen

  • Streambarer HTTP-MCP-Endpunkt (/mcp)

  • Bearer-/API-Key-Authentifizierung

  • Voll-Vault-Modus (ALLOWLIST=*) oder Ordner-Allowlists

  • Lese-Tools: list_notes, list_folder, read_note, search_notes

  • Schreib-Tools: create_note, append_note, update_note, create_folder, rename_path, delete_path

  • Blockiert .obsidian, .git, Dotfiles, .env und Schlüsselmaterial

  • Atomare Schreibvorgänge + Größenbegrenzungen

  • Health-Endpunkt für den Betrieb: /healthz

Related MCP server: obsidian_mcp

Schnellstart

npm install
export VAULT_ROOT="/absolute/path/to/your/vault"
export BEARER_TOKEN="$(openssl rand -hex 32)"
export ALLOWLIST="*"
export WRITE_ALLOWLIST="*"
export MODE="read-write"
export PORT=8790
export BIND=127.0.0.1
export PUBLIC_BASE="http://127.0.0.1:8790"
npm start

Health-Check:

curl -s http://127.0.0.1:8790/healthz | jq .

Umgebungsvariablen

Variable

Required

Default

Description

VAULT_ROOT

ja

—

Absoluter Pfad zum Obsidian-Vault

BEARER_TOKEN

ja

—

Gemeinsames Geheimnis für MCP-Clients

ALLOWLIST

nein

sample folders

Kommagetrennte Liste relativer Ordner oder * für den gesamten Vault

WRITE_ALLOWLIST

nein

wie ALLOWLIST

Schreibbereich; * = gesamter Vault (blockiert weiterhin Geheimnisse/Dotfiles)

MODE

nein

read-write

read-write oder read-only

PORT

nein

8790

Listener-Port

BIND

nein

127.0.0.1

Bind-Adresse

PUBLIC_BASE

nein

http://127.0.0.1:8790

Öffentliche Basis-URL, die in den Metadaten angekündigt wird

MAX_SEARCH_HITS

nein

25

Obergrenze für Suchergebnisse

MAX_FILE_BYTES

nein

400000

Maximale Notizgröße beim Lesen

MAX_WRITE_BYTES

nein

350000

Maximale Notizgröße beim Schreiben

Akzeptierte Authentifizierungs-Header:

  • Authorization: Bearer <token>

  • X-Api-Key: <token>

  • X-Obsidian-Token: <token>

MCP-Tools

Lesen

  • list_notes — Markdown-Pfade auflisten (optionales Präfix)

  • list_folder — Dateien/Verzeichnisse auflisten (recursive optional)

  • read_note — eine Notiz + einfaches Frontmatter lesen

  • search_notes — Suche nach Teilzeichenfolgen ohne Beachtung von Groß-/Kleinschreibung

Schreiben (wenn MODE=read-write)

  • create_note — Markdown-Notiz erstellen (overwrite optional)

  • append_note — an Notiz anhängen

  • update_note — gesamte Notiz ersetzen

  • create_folder — Ordnerstruktur erstellen

  • rename_path — Datei oder Ordner umbenennen/verschieben

  • delete_path — Markdown-Datei oder -Ordner löschen (recursive bei nicht-leeren Ordnern)

Sicherheit:

  • liefert niemals .obsidian, .git, versteckte Pfade, .env oder Schlüsseldateien aus

  • Schreiben auf .md / .markdown / .txt beschränkt

  • geschützte Strukturanker der obersten Ebene können nicht vollständig gelöscht werden

  • Keine Geheimnisse gehören in den Vault oder in diese in Git eingecheckte Serverkonfiguration.

Reverse-Proxy-Beispiel (nginx)

location ^~ /obsidian-mcp/ {
  proxy_pass http://127.0.0.1:8790/;
  proxy_http_version 1.1;
  proxy_set_header Host $host;
  proxy_set_header Authorization $http_authorization;
  proxy_set_header X-Api-Key $http_x_api_key;
  proxy_buffering off;
}

Nur über HTTPS verfügbar machen und BIND=127.0.0.1 am Node-Prozess belassen.

Grok-/Agent-Prompt-Ausschnitt

You have MCP tools for an Obsidian vault via obsidian-vault-mcp.

Rules:
1. First call list_folder path="" to see top-level structure.
2. Read OBSIDIAN-STRUCTURE.md if present before reorganizing.
3. Prefer append_note for changelogs; do not rewrite history casually.
4. Create notes only as .md under clear topic folders.
5. Never store secrets, tokens, private keys, or .env values.
6. Use search_notes before creating near-duplicate docs.
7. Use rename_path to organize; use delete_path only for clearly obsolete drafts.

Sicherheitshinweise

  • Dieser Server ist mächtig. Behandle BEARER_TOKEN wie ein Passwort.

  • In Produktion Netzwerkisolierung + Reverse-Proxy-Authentifizierung bevorzugen.

  • Der Voll-Vault-Schreibmodus ist für vertrauenswürdige interne Agenten vorgesehen; ziehe WRITE_ALLOWLIST für weniger vertrauenswürdige Bots enger.

  • .env, Tokens oder echte Vault-Inhalte nicht in Git einchecken.

Lizenz

MIT

Related MCP Connectors

Related MCP Servers

  • F
    license
    Not graded
    quality
    C
    maintenance
    Enables reading, writing, searching, and managing Obsidian vault notes through MCP tools and prompts, allowing AI agents to interact with local knowledge bases.
    -
  • F
    license
    Not graded
    quality
    C
    maintenance
    Enables MCP clients to search, read, list, and append to markdown notes in a local Obsidian vault or folder of .md files.
    -