Skip to main content
Glama
JulioMCruz

obsidian-vault-mcp

by JulioMCruz

Obsidian Vault MCP

HTTP Model Context Protocol сервер, который предоставляет AI-агентам контролируемый доступ к локальному хранилищу Obsidian.

Создан для сред выполнения агентов (Grok-боты, Claude, OpenClaw, пользовательские MCP-клиенты), которым необходимо просматривать, искать, создавать, обновлять, переименовывать и аккуратно удалять заметки в формате Markdown.

Возможности

  • Потоковая HTTP-конечная точка MCP (/mcp)

  • Аутентификация через Bearer / API-ключ

  • Полный доступ к хранилищу (ALLOWLIST=*) или разрешённые папки

  • Инструменты чтения: list_notes, list_folder, read_note, search_notes

  • Инструменты записи: create_note, append_note, update_note, create_folder, rename_path, delete_path

  • Блокировка .obsidian, .git, скрытых файлов, .env и ключевых материалов

  • Атомарная запись + ограничения размера

  • Конечная точка для проверки работоспособности: /healthz

Related MCP server: obsidian_mcp

Быстрый старт

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

Проверка работоспособности:

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

Переменные окружения

Переменная

Обязательная

По умолчанию

Описание

VAULT_ROOT

да

—

Абсолютный путь к хранилищу Obsidian

BEARER_TOKEN

да

—

Общий секрет для MCP-клиентов

ALLOWLIST

нет

образцы папок

Список относительных папок через запятую или * для всего хранилища

WRITE_ALLOWLIST

нет

как ALLOWLIST

Область записи; * = всё хранилище (скрытые файлы/секреты по-прежнему блокируются)

MODE

нет

read-write

read-write или read-only

PORT

нет

8790

Порт для прослушивания

BIND

нет

127.0.0.1

Адрес привязки

PUBLIC_BASE

нет

http://127.0.0.1:8790

Публичный базовый URL, указываемый в метаданных

MAX_SEARCH_HITS

нет

25

Максимальное количество результатов поиска

MAX_FILE_BYTES

нет

400000

Максимальный размер файла для чтения

MAX_WRITE_BYTES

нет

350000

Максимальный размер файла для записи

Принимаемые заголовки аутентификации:

  • Authorization: Bearer <token>

  • X-Api-Key: <token>

  • X-Obsidian-Token: <token>

Инструменты MCP

Чтение

  • list_notes — список путей к заметкам Markdown (необязательный префикс)

  • list_folder — список файлов и папок (recursive — необязательно)

  • read_note — чтение одной заметки + простой frontmatter

  • search_notes — поиск без учёта регистра по подстроке

Запись (при MODE=read-write)

  • create_note — создание заметки Markdown (overwrite — необязательно)

  • append_note — добавление текста к заметке

  • update_note — полная замена заметки

  • create_folder — создание дерева папок

  • rename_path — переименование или перемещение файла/папки

  • delete_path — удаление файла или папки Markdown (recursive — для непустых папок)

Безопасность:

  • никогда не обслуживает .obsidian, .git, скрытые пути, .env и ключевые файлы

  • запись ограничена .md / .markdown / .txt

  • защищённые структурные якоря нельзя удалить

  • никакие секреты не хранятся в хранилище и не попадают в конфигурацию сервера в репозитории

Обратный прокси (пример 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;
}

Открывайте доступ только через HTTPS и оставляйте BIND=127.0.0.1 в процессе Node.

Фрагмент для Grok / агента

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.

Замечания по безопасности

  • Этот сервер обладает широкими возможностями. Относитесь к BEARER_TOKEN как к паролю.

  • В production предпочтительна сетевая изоляция + аутентификация через обратный прокси.

  • Режим полной записи в хранилище предназначен для доверенных внутренних агентов; для менее доверенных ботов ужесточайте WRITE_ALLOWLIST.

  • Не коммитьте .env, токены и реальное содержимое хранилища в репозиторий.

Лицензия

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.
    -