Skip to content

README.ru.md

Latest commit

 

History

History
94 lines (61 loc) · 6.86 KB

README.ru.md

File metadata and controls

94 lines (61 loc) · 6.86 KB
Raw
Логотип Obsidian

Knowledge Analytics для Obsidian

Продвинутая графовая аналитика, валидация Google OKF и гигиена контекста для вашего хранилища.

🇺🇸 English | 🇷🇺 Русский

Релиз Лицензия Версия Obsidian

Этот плагин служит движком данных для сервера obsidian-knowledge-mcp.

⚠️ Обязательные и сопутствующие зависимости

ВАЖНО: Для работы полнотекстового поиска и ранжирования BM25 обязательно установите и включите плагин Omnisearch в вашем хранилище Obsidian.

Для MCP- и agent-сценариев, которым нужен стандартный REST-доступ к vault Obsidian, установите и включите Local REST API.

Knowledge Analytics также поднимает собственный локальный HTTP API на 127.0.0.1:27125; он предназначен для obsidian-knowledge-mcp, а не для оригинального upstream Obsidian MCP server.

Knowledge Analytics намеренно работает по модели Omnisearch-first: Omnisearch остаётся единственным полнотекстовым поисковым индексом, а этот плагин добавляет поверх его результатов графовое ранжирование, секции, provenance, health-проверки, route tracing, clustering, benchmark и write-safety диагностику. UI внутри Obsidian остаётся сервисным и не дублирует поисковый интерфейс Omnisearch.

🌟 Обзор

Knowledge Analytics следит за структурными границами и выполняет тяжелый графовый анализ, который Obsidian не поддерживает из коробки. Плагин создавался для того, чтобы хранилище оставалось чистым и масштабируемым — как для людей, так и для автономных ИИ-агентов.

🛡️ Основные возможности

  • Валидация Google OKF (Open Knowledge Format): Автоматическая проверка структуры заметок. Файлы без обязательных полей type и summary/description во frontmatter помечаются встроенным сканнером Janitor. Подробнее в спецификации Google OKF.
  • Обход графа (BFS): Графовый алгоритм поиска кратчайшего пути между двумя любыми заметками (до 2000 узлов).
  • Пенализация логов (Lineage Demotion): Автоматически сгенерированные файлы, логи и дейлики пенализируются в результатах поиска, чтобы не засорять базу знаний.
  • Кластеризация концептов (Concept Clustering): Анализ ближайшего окружения заметки для поиска кросс-ссылок и семантических соседей.
  • Отчет о здоровье хранилища (Health Reports): Генерация сводки по рабочему пространству (поиск заметок-сирот, пустых хабов и сломанных метаданных).

⚙️ Установка

Вариант А: Ручная установка (Рекомендуется)

  1. Скачайте main.js, manifest.json и styles.css из последнего Релиза.
  2. Создайте папку knowledge внутри вашей директории .obsidian/plugins/.
  3. Поместите скачанные файлы в эту папку.
  4. Перезапустите Obsidian и включите Knowledge Analytics в Community Plugins.

Вариант Б: Установка из локальной разработки

Передайте путь к вашему vault явно:

npm run install:plugin -- --vault "D:\path\to\vault"

Или через переменную окружения:

$env:OBSIDIAN_VAULT_PATH = "D:\path\to\vault"
npm run install:plugin

Скрипт собирает плагин и копирует main.js, manifest.json, styles.css в .obsidian/plugins/knowledge. Если в vault найдены другие папки с тем же manifest.id, скрипт предупредит об этом.

Вариант В: Установка через BRAT (Для тестирования)

  1. Установите BRAT из списка Community Plugins.
  2. Добавьте pradigmaz/knowledge-obsidian-plugin в список репозиториев BRAT.
  3. Включите Knowledge Analytics в Community Plugins.

🚀 Использование

Плагин работает на локальном HTTP API. В настройках Knowledge Analytics внутри Obsidian можно управлять сервером, портом, копированием MCP config, статусом Omnisearch, health summary и degradation diagnostics. Он отвечает на внутренние REST API запросы от obsidian-knowledge-mcp.

📄 Лицензия

Проект распространяется по лицензии MIT — подробности в файле LICENSE.