переведено ИИ

MCP-сервер для Obsidian

MCP-сервер для взаимодействия с Obsidian через плагин сообщества Local REST API.

Компоненты

Инструменты

Сервер реализует множество инструментов для взаимодействия с Obsidian:

list_files_in_vault: Выводит список всех файлов и директорий в корневой директории вашего хранилища Obsidian
list_files_in_dir: Выводит список всех файлов и директорий в указанной директории Obsidian
get_file_contents: Возвращает содержимое одного файла в вашем хранилище.
search: Ищет документы, соответствующие указанному текстовому запросу, по всем файлам в хранилище.
patch_content: Вставляет содержимое в существующую заметку относительно заголовка, ссылки на блок или поля frontmatter.
append_content: Добавляет содержимое в новый или существующий файл в хранилище.
delete_file: Удаляет файл или директорию из вашего хранилища.

Примеры запросов

Хорошей практикой является сначала указать Claude использовать Obsidian. Тогда он всегда будет вызывать инструменты.

Используйте запросы такие как: - Получить содержимое последней заметки о встрече по архитектуре и сделать их краткое изложение. - Найти все файлы, где упоминается Azure CosmosDb, и кратко объяснить мне контекст, в котором он упоминается. - Сделать краткое изложение последних заметок о встрече и поместить их в новую заметку 'summary meeting.md'. Добавьте введение, чтобы я мог отправить ее по электронной почте.

Конфигурация

Ключ API REST Obsidian

Существует два способа настроить окружение с ключом API REST Obsidian.

Добавить в конфигурацию сервера (предпочтительно)

{
  "mcp-obsidian": {
    "command": "uvx",
    "args": [
      "mcp-obsidian"
    ],
    "env": {
      "OBSIDIAN_API_KEY": "<your_api_key_here>",
      "OBSIDIAN_HOST": "<your_obsidian_host>",
      "OBSIDIAN_PORT": "<your_obsidian_port>"
    }
  }
}

Иногда у Claude возникают проблемы с определением местоположения uv / uvx. В таких случаях вы можете использовать which uvx, чтобы найти и вставить полный путь в конфигурацию выше.

Создайте файл .env в рабочей директории со следующими обязательными переменными:

OBSIDIAN_API_KEY=your_api_key_here
OBSIDIAN_HOST=your_obsidian_host
OBSIDIAN_PORT=your_obsidian_port

Примечание: - Ключ API можно найти в конфигурации плагина Obsidian. - По умолчанию используется порт 27124, если не указан другой. - По умолчанию используется хост 127.0.0.1, если не указан другой.

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

Установка

Obsidian REST API

Вам необходим работающий плагин сообщества Obsidian REST API: https://github.com/coddingtonbear/obsidian-local-rest-api

Установите и включите его в настройках и скопируйте ключ API.

Claude Desktop

На MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json

На Windows: %APPDATA%/Claude/claude_desktop_config.json

Конфигурация для разработки / неопубликованных серверов

{
"mcpServers": {
  "mcp-obsidian": {
    "command": "uv",
    "args": [
      "--directory",
      "<dir_to>/mcp-obsidian",
      "run",
      "mcp-obsidian"
    ],
    "env": {
      "OBSIDIAN_API_KEY": "<your_api_key_here>",
      "OBSIDIAN_HOST": "<your_obsidian_host>",
      "OBSIDIAN_PORT": "<your_obsidian_port>"
    }
  }
}
}

Конфигурация для опубликованных серверов

{
"mcpServers": {
  "mcp-obsidian": {
    "command": "uvx",
    "args": [
      "mcp-obsidian"
    ],
    "env": {
      "OBSIDIAN_API_KEY": "<YOUR_OBSIDIAN_API_KEY>",
      "OBSIDIAN_HOST": "<your_obsidian_host>",
      "OBSIDIAN_PORT": "<your_obsidian_port>"
    }
  }
}
}

Разработка

Сборка

Для подготовки пакета к распространению:

Синхронизируйте зависимости и обновите файл блокировки:

uv sync

Отладка

Поскольку MCP-серверы работают через stdio, отладка может быть сложной. Для наилучшего опыта отладки мы настоятельно рекомендуем использовать MCP Inspector.

Вы можете запустить MCP Inspector через npm с помощью этой команды:

npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-obsidian run mcp-obsidian

При запуске Inspector отобразит URL-адрес, который вы можете открыть в браузере для начала отладки.

Вы также можете просматривать журналы сервера с помощью этой команды:

tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-obsidian.log

MCP Obsidian