Skip to content

Repository files navigation

Obsidian Logo

Knowledge Analytics for Obsidian

Advanced graph analytics, Google OKF validation, and context hygiene for your vault.

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

Release License Obsidian Version

This plugin is the local data engine for the obsidian-knowledge-mcp fork. The original cyanheads/obsidian-mcp-server remains the general Obsidian MCP server; this plugin powers the fork's extra obsidian_knowledge_* tools.


⚠️ Required And Companion Dependencies

IMPORTANT: To enable full-text search and BM25 ranking, this plugin strictly requires the Omnisearch plugin to be installed and enabled in your vault.

For MCP and agent workflows that access Obsidian through the standard vault REST surface, install and enable Local REST API.

Knowledge Analytics also exposes its own local-only HTTP API on 127.0.0.1:27125. It is meant to be consumed by the obsidian-knowledge-mcp fork, not by the original upstream Obsidian MCP server.

Knowledge Analytics is intentionally Omnisearch-first: Omnisearch remains the only full-text search index, while this plugin adds graph scoring, section references, provenance, health checks, route tracing, clustering, benchmarks, and write-safety diagnostics on top of Omnisearch results. The Obsidian UI is limited to service controls and diagnostics; it does not duplicate the Omnisearch search interface.


🌟 Overview

Knowledge Analytics enforces structural boundaries and performs heavy graph analysis that native Obsidian does not natively support. It is designed to keep your vault clean, scalable, and readable for both humans and autonomous AI agents.

🛡️ Core Features

  • Google OKF (Open Knowledge Format) Validation: Automatically scans notes for structural compliance. Notes missing the mandatory type and summary/description frontmatter fields are flagged by the Janitor scanner. Read the Google OKF Spec for details.
  • BFS Route Tracing: Graph algorithm to find the shortest path of connections between any two notes in your vault (up to a 2000-node limit).
  • Lineage Demotion: Auto-generated files, logs, and daily dumps are algorithmically penalized in search results so they don't pollute your primary knowledge base.
  • Concept Clustering: Analyzes a note's immediate neighborhood to surface cross-links and semantic neighbors.
  • Vault Health Reports: Generates a brief of your workspace, highlighting orphaned notes, empty hubs, and metadata regressions.

⚙️ Installation

Option A: Manual Installation (Recommended for Production)

  1. Download main.js, manifest.json, and styles.css from the latest Release.
  2. Create a folder named knowledge inside your .obsidian/plugins/ directory.
  3. Place the downloaded files into that folder.
  4. Reload Obsidian and enable Knowledge Analytics in Community Plugins.

Option B: Local Development Install

Pass your vault path explicitly:

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

Or use an environment variable:

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

The script builds the plugin and copies main.js, manifest.json, and styles.css into .obsidian/plugins/knowledge. If the vault contains other folders with the same manifest.id, the script prints a warning.

Option C: Using BRAT (For Beta Testing)

  1. Install BRAT from the Community Plugins list.
  2. Add pradigmaz/knowledge-obsidian-plugin to your BRAT repository list.
  3. Enable Knowledge Analytics in Community Plugins.

🚀 Usage

The plugin exposes a local HTTP API. You can control the server, port, MCP config copy, Omnisearch status, health summary, and degradation diagnostics from the Knowledge Analytics settings tab in Obsidian. It responds to internal REST API calls made by the obsidian-knowledge-mcp fork.

Quick local check:

Invoke-WebRequest -Uri 'http://127.0.0.1:27125/api/status' -TimeoutSec 5 -SkipHttpErrorCheck
Invoke-RestMethod -Uri 'http://127.0.0.1:27125/api/bootstrap' -Headers @{ 'X-Schema-Version'='0.1.0' } -Method Post -ContentType 'application/json' -Body '{"query":"Knowledge Analytics status","limit":3}' -TimeoutSec 10

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages