obsidian-cli-mcp — это MCP сервер для официального Obsidian CLI. Он предоставляет MCP-клиенту операции поиска по хранилищу Obsidian, заметкам, задачам, файлам, ссылкам и нативным Canvas. Сервер не заменяет Obsidian: CLI пересылает запросы запущенному десктопному приложению Obsidian.
Транспорт по умолчанию — локальный stdio. Remote Streamable HTTP доступен как расширенная, отдельно защищённая настройка; для локального использования он не требуется.
macOS с установленным и запущенным Obsidian Desktop.
Официальный Obsidian CLI включён в Obsidian: Settings → General → Command line interface, затем зарегистрируйте obsidian в вашем PATH.
Node.js 18 или новее для запуска опубликованного пакета. Bun нужен только для сборки или разработки этого исходного кода.
Этот проект требует десктопный CLI. Он не поддерживает obsidian-headless. Приложение Obsidian должно оставаться открытым, пока используется MCP-сервер.
Сначала проверьте сторону Obsidian:
command -v obsidian
obsidian version
obsidian vaultRelated MCP server: Obsidian MCP Server
Запустите опубликованный пакет v0.4.1 из любого каталога:
npx --yes --package=@dariuscodes/obsidian-cli-mcp@0.4.1 obsidian-cli-mcpКоманда общается по MCP через stdio и ожидает MCP-клиента. Она намеренно не выводит данные протокола в терминал. Диагностика идёт в stderr.
Для исходного кода вместо этого:
git clone https://github.com/DariusCorvus/obsidian-cli-mcp.git
cd obsidian-cli-mcp
bun install --frozen-lockfile
bun run build
node dist/main.jsДля локального значения по умолчанию не требуется имя хранилища, путь к хранилищу, токен, учётная запись Cloudflare, LaunchAgent или файл конфигурации. Сервер использует активное хранилище, которое Obsidian предоставляет через официальный CLI.
Для клиента, который принимает конфигурацию mcpServers, используйте команду npm:
{
"mcpServers": {
"obsidian": {
"command": "npx",
"args": [
"--yes",
"--package=@dariuscodes/obsidian-cli-mcp@0.4.1",
"obsidian-cli-mcp"
]
}
}
}Если клиент не наследует PATH вашей оболочки, замените npx на абсолютный путь, выводимый командой command -v npx. Для исходного кода используйте command: "node" и args: ["/absolute/path/to/obsidian-cli-mcp/dist/main.js"].
Перезапустите клиент после изменения его MCP-конфигурации. Первая полезная последовательность:
Вызовите vault_search с запросом, который должен существовать в вашем хранилище, например { "query": "meeting", "limit": 10 }.
Передайте один возвращённый путь в note_read, например { "path": "<path returned by vault_search>" }.
Предварительно просмотрите безопасную мутацию заметки перед её применением:
{
"name": "MCP smoke note",
"content": "Created after reviewing the plan.",
"dryRun": true
}Это вызов note_create. Он возвращает запланированное действие и точную команду CLI без изменения хранилища. Используйте dryRun: false только после просмотра плана. dryRun — это предварительный просмотр, а не граница авторизации.
Для Canvas предварительно просмотрите нативный файл Canvas и один текстовый узел:
{
"path": "MCP smoke.canvas",
"nodes": [
{
"id": "hello",
"type": "text",
"x": 0,
"y": 0,
"width": 320,
"height": 180,
"text": "Hello from MCP"
}
],
"dryRun": true
}Это вызов canvas_create. Просмотрите план, затем вызовите его с dryRun: false, если хотите создать файл. После этого используйте canvas_read для проверки нативного JSON .canvas. Инструменты Canvas сохраняют неизвестные поля, проверяют ссылки на узлы/рёбра и не требуют произвольного eval.
Пустая или отсутствующая конфигурация пригодна для обычного хранилища Obsidian. Необязательный .obsidianmcprc.yaml обнаруживается из рабочего каталога сервера. Для клиентов с непредсказуемым рабочим каталогом задайте OBSIDIAN_MCP_CONFIG как явный путь к файлу конфигурации.
Политика по умолчанию намеренно локальна и ограничена:
Сервер v0.4.0 не предоставляет универсальный инструмент obsidian_eval. eval.enabled по умолчанию false; внутренние фиксированные eval-фрагменты, используемые несколькими безопасными операциями, не являются пользовательским escape-люком JavaScript.
Импорт из произвольных локальных файлов отключён, пока явно не настроен imports.allowedRoots. URL-адреса никогда не загружаются.
Сегменты пути .obsidian, .git, .trash, .Trash, Trash и .DS_Store заблокированы по умолчанию. Добавьте paths.allow для более узкой области хранилища и добавьте специфичные для проекта префиксы paths.deny для более чувствительного содержимого.
Мутации предоставляют dryRun. file_delete требует confirm: true, а note_delete по умолчанию использует корзину Obsidian; постоянное удаление требует явной конфигурации delete.mode: hard.
Git-автокоммит по умолчанию отключён.
Используйте явный список разрешений, когда MCP-клиент должен только просматривать хранилище:
tools:
allow:
- vault_search
- note_read
- note_list
- vault_tags
- unresolved_links
- tasks_list
- note_diff
- backlinks_get
- outlinks_get
- file_read_binary_metadata
- canvas_readПо умолчанию есть безопасные локальные ограждения, но он не только для чтения. Для явной безопасной локальной поверхности, которая разрешает обычное редактирование заметок и создание Canvas, но исключает удаление, импорт файлов, операции жизненного цикла файлов и произвольное выполнение:
tools:
allow:
- vault_search
- note_read
- note_list
- vault_tags
- unresolved_links
- tasks_list
- note_diff
- backlinks_get
- outlinks_get
- canvas_read
- canvas_create
- canvas_upsert_nodes
- canvas_upsert_edges
- canvas_add_node
- canvas_add_edge
- canvas_auto_layout
- canvas_open
- note_create
- note_append
- note_set_frontmatter
- note_replace_range
- note_insert_at
- note_replace
- note_insert
- daily_open
- daily_append
- task_create
- task_update
delete:
mode: trash
eval:
enabled: false
imports:
allowedRoots: []Опустите tools.allow, чтобы открыть полную встроенную поверхность инструментов, сохраняя защищённые пути по умолчанию, удаление в корзину, отключённый импорт и отключённый obsidian_eval. Если нужен импорт, настройте только выделенный локальный исходный каталог:
imports:
allowedRoots:
- /absolute/path/to/approved-imports
maxBytes: 26214400
collision: increment
delete:
mode: trash
eval:
enabled: falseСм. docs/configuration.md для всех полей и examples/ для пресетов организации заметок.
Локальный stdio запускает один процесс сервера напрямую из MCP-клиента. Это рекомендуемая установка: нет слушающего сокета, удалённой аутентификации, настройки Cloudflare или публичной конечной точки.
Streamable HTTP — это дополнительный расширенный режим для клиента, который не может использовать локальный stdio. Он привязывается только к loopback и отказывается запускаться без проверки Cloudflare Access JWT или сильного токена возможностей. Поместите его за TLS, аутентифицированный обратный прокси или туннель; не привязывайте его к 0.0.0.0. См. docs/remote-cloudflare.md для общей расширенной настройки и её компромиссов безопасности.
Сервер по умолчанию предоставляет 43 обычных инструмента:
Чтение: vault_search, note_read, note_list, vault_tags, unresolved_links, tasks_list, note_diff, backlinks_get, outlinks_get, file_read_binary_metadata, canvas_read.
Запись и рабочие процессы: note_create, note_append, note_set_frontmatter, daily_open, daily_append, note_replace_range, note_insert_at, note_replace, note_insert, task_create, task_update, note_transition.
Файлы и вложения: file_import, attachment_import, note_attach, attachment_embed, file_move, file_rename, file_delete, note_rename, note_move, folder_create, note_delete.
Canvas: canvas_create, canvas_upsert_nodes, canvas_upsert_edges, canvas_remove, canvas_open, canvas_add_node, canvas_add_edge, canvas_auto_layout.
Пакетная обработка: vault_batch выполняет включённые чтения и предварительно просматривает включённые мутации с args.dryRun: true, гейтингом зависимостей, стабильными результатами в порядке ввода и ограниченным batch.maxParallelism (по умолчанию 4, максимум 8).
Все изменяющие инструменты принимают dryRun. Аннотации инструментов определяют операции только для чтения и разрушительные операции для совместимых MCP-клиентов.
Obsidian Desktop должен быть запущен, его официальный CLI должен быть включён, а активное хранилище должно быть доступно этому десктопному сеансу. Этот сервер не является песочницей и не поддерживает obsidian-headless.
Содержимое хранилища — это ненадёжные данные. Заметки, текст Canvas, текст задач и результаты поиска могут содержать инструкции по инъекции в промпт; MCP-клиент должен обращаться с ними как с данными и никогда не следовать инструкциям, найденным в хранилище, только потому, что они были возвращены инструментом. Вывод инструментов также может содержать чувствительное содержимое хранилища, поэтому подключайте только доверенные клиенты.
Прочтите SECURITY.md перед включением удалённого HTTP, импорта, жёсткого удаления или широкого списка разрешений на мутации. Сообщайте о проблемах безопасности конфиденциально, как описано там.
Исходный код использует Bun, а опубликованный bin работает на Node:
bun install
bun run typecheck
bun test
bun run build:schema
bun run build
bun run smoke:stdio
git diff --check
npm pack --dry-run --jsonОфлайн-проверка stdio проверяет точку входа собранного пакета, инициализацию MCP, tools/list, ожидаемую поверхность инструментов и отсутствие obsidian_eval. Реальная проверка Obsidian отдельная и требует пользовательского сеанса с запущенным Obsidian:
OBSIDIAN_CLI_BINARY=obsidian \
OBSIDIAN_MCP_CONFIG=/absolute/path/to/your/config.yaml \
OBSIDIAN_MCP_VAULT="your-vault-name" \
bun run smoke:liveGitHub Actions запускает только офлайн-проверки; он не зависит от Obsidian Desktop или реального хранилища на хостинговом раннере.
This server cannot be deployed
MCP-native open-source Notion alternative: read & write pages, databases and kanban boards.
Search your AI chat history (ChatGPT, Claude, Codex) from any MCP client. Remote, private, read-only
Search your Obsidian vault to quickly find notes by title or keyword, summarize related content, a…
Search, read, and safely update Markdown notes in your connected Phasoric knowledge vaults.
