Obsidian MCP Server

👁 npm version

obsidian-mcp-server — это MCP-сервер, который позволяет ИИ-агентам просматривать, искать и обобщать Markdown-документы в Obsidian Vault.

Этот проект выходит за рамки простого чтения документов: он предоставляет функцию локального гибридного поиска с использованием transformers.js и включает интерактивный CLI ИИ-агент с UI, позволяющий общаться с вашим Vault прямо из терминала.

Основные характеристики

• 🔍 Гибридный поиск: Сочетает ключевые слова и семантический (векторный) поиск, обеспечивая оптимальные результаты с помощью RRF (Reciprocal Rank Fusion) и переранжирования (Reranking).

• 🚀 Локальный ИИ без зависимостей: Использует @huggingface/transformers для запуска моделей эмбеддингов и переранжирования непосредственно внутри процесса Node.js (внешний API-сервер не требуется).

• 💬 Встроенный CLI-агент: Предоставляет терминальный интерфейс, позволяющий задавать вопросы по содержимому Vault и получать ответы с использованием инструментов MCP. Подробнее

• 📦 Оптимизация токенов: Предоставляет различные режимы сжатия и ограничения вывода для контроля использования токенов ИИ-агентом.

Что можно делать (Инструменты MCP)

• Интегрированный поиск (vault, action="search"): Одновременный поиск по ключевым словам и смыслу для нахождения релевантных документов.

• Чтение документов (vault, action="read"): Просмотр содержимого и метаданных конкретной заметки.

• Общий список и статистика (vault, action="list_all"|"stats"): Проверка общего состояния Vault и списка файлов.

• Сбор контекста (vault, action="collect_context"): Создание высокоплотных пакетов знаний, связанных с определенной темой.

• Загрузка знаний (vault, action="load_memory"): Вызов сохраненных снимков памяти.

• Управление Frontmatter (generate_property|write_property): Генерация и применение метаданных на основе ИИ.

• Организация вложений (organize_attachments): Автоматическое перемещение изображений из документов в выделенную папку и обновление ссылок.

Установка и настройка

1. Предварительные требования

• Node.js: v22.0.0 или выше

• Obsidian Vault: Необходимо знать абсолютный путь к нему.

2. Установка локальных ИИ-моделей (обязательно)

Чтобы активировать функции семантического поиска и переранжирования, необходимо загрузить необходимые локальные модели с помощью следующей команды:

# 로컬 임베딩 및 리랭킹 모델 설치
npx @sunub/obsidian-mcp-server setup

Или, если пакет уже установлен:

obsidian-mcp-server setup

Эта команда загружает модели Xenova/paraphrase-multilingual-MiniLM-L12-v2 (эмбеддинги) и Xenova/bge-reranker-base (переранжирование) и сохраняет их в локальном кэше.

3. Настройка переменных окружения

Пример настройки MCP-клиента

В настройках каждого клиента измените env.VAULT_DIR_PATH на путь к вашему Vault.

Claude Desktop / Cursor / Copilot

{
 "mcpServers": {
 "obsidian": {
 "command": "npx",
 "args": ["-y", "@sunub/obsidian-mcp-server@latest"],
 "env": {
 "VAULT_DIR_PATH": "/Users/username/Documents/MyVault"
 }
 }
 }
}

Как работает гибридный поиск

Для улавливания семантических связей, которые трудно найти с помощью обычного поиска по ключевым словам, используется следующий конвейер:

1. Поиск по ключевым словам: Извлечение результатов точного совпадения слов через внутренний Indexer.

2. Векторный поиск: Поиск семантически похожих фрагментов с использованием LanceDB и эмбеддингов transformers.js.

3. RRF Fusion: Объединение рангов двух результатов поиска с помощью алгоритма Reciprocal Rank Fusion.

4. Локальное переранжирование: Повторная оценка объединенных верхних результатов с помощью модели BGE Reranker для определения финального рейтинга.

Если модели не установлены, система автоматически переходит в режим поиска только по ключевым словам и выводит в терминал сообщение с рекомендацией выполнить npx @sunub/obsidian-mcp-server setup.

Интерактивный CLI ИИ-агент с UI

В этот проект встроен терминальный ИИ-чат-интерфейс, оптимизированный для Obsidian Vault.

Характеристики

• Интеграция RAG: При задании вопроса автоматически собирает соответствующий контекст из Vault и передает его в LLM.

• Потоковая передача в реальном времени: Отображает ответы LLM и "процесс мышления ()" в реальном времени.

• Слэш-команды: Возможность вызова инструментов MCP напрямую из CLI, например /search, /read, /index.

• Управление несколькими MCP: Мониторинг состояния и списка инструментов всех подключенных MCP-серверов.

Как запустить

1. Запуск сервера модели чата: Запустите сервер, такой как llama.cpp или Ollama, в режиме совместимости с OpenAI.

   • Например: llama-server -m models/gemma-2-9b-it.Q4_K_M.gguf --port 8080

2. Запуск CLI:

# 환경변수와 함께 실행
VAULT_DIR_PATH="/your/vault" LLM_API_URL="http://localhost:8080" npx @sunub/obsidian-mcp-server

Справка по слэш-командам

• /search <keyword>: Выполнение гибридного поиска

• /read "filename": Чтение конкретного документа

• /stats: Проверка состояния Vault

• /index: Принудительная переиндексация векторной БД

• /tools: Просмотр списка всех доступных инструментов MCP

• /help: Просмотр справки

Лицензия

Apache-2.0

Maintenance

Resources

• Remote Server
• NPM Package
• GitHub Repository
Need Help?Related Servers

Tools

• create_document_with_propertiesA
• generate_propertyA
• organize_attachmentsA
• vaultA
• write_propertyA