Skip to main content

Orchestration layer for the KGRAG(tm) components.

Project description

Python License: Elastic-2.0 Version CI Poetry DOI

KGRAG logo

KGRAG — Knowledge Compiler and Federated Retrieval Layer for Ontologically Grounded Domains

Author: Eric G. Suchanek, PhD · Flux-Frontiers, Liberty TWP, OH


Overview

KGRAG architecture

KGRAG is a federation and orchestration layer for structural knowledge graphs derived from heterogeneous source domains. It integrates PyCodeKG (Python codebase analysis), DocKG (semantic document indexing), MetaboKG (metabolic pathways), DiaryKG (personal diary corpora), AgentKG (conversational memory), FTreeKG (file system trees), and a growing family of domain-specific backends under a single five-method adapter protocol.

KGRAG treats derived structure as ground truth and uses semantic embeddings strictly as an acceleration layer for locating entry points into that structure. All graph traversal, ranking, and snippet extraction is deterministic. When KGRAG output is passed to a language model for synthesis, the model receives verified facts with full source provenance — not approximate embeddings.

How this differs from RAG and KG-RAG: RAG embeds text chunks and retrieves by approximate similarity — no structure, no provenance. KG-RAG (GraphRAG, LlamaIndex KG) uses an LLM to extract entities and edges from text: the graph is inferred, inheriting the extractor's hallucinations. KGRAG derives its graphs from formal source structure — ASTs for code, parse trees for prose, reaction schemas for biochemistry — with no language model in the pipeline. The graph is correct by construction. Embeddings are disposable; the graph is not. The retrieval layer cannot hallucinate.

Technical paper · Manifesto


KG Types

Fully Implemented

Kind Backend Description
code PyCodeKG Python codebase — AST-extracted modules, classes, functions, call graphs
doc DocKG Document corpus — Markdown/RST/text indexed by topic, section, and entity
meta MetaboKG Metabolic pathways — biochemical reaction networks (KEGG, BioCyc)
diary DiaryKG Personal diary entries — timestamped chunk graphs with temporal edges
agent AgentKG Conversational memory — Turn/Topic/Task/Summary graph (live session)
filetree FTreeKG File system tree — directory/file/module/dependency structure
memory MemoryKG Episodic memory — hybrid semantic + structural graph for conversation/event corpora
gutenberg GutenbergKG Project Gutenberg book corpus — literature indexed by author, genre, and chapter via DocKG-compatible indices

Stub Adapters (protocol boundary, backends under development)

Kind Backend Description
ia IABookKG Internet Archive book corpus — public-domain books indexed by genre and topic
pdbfile PDB structure files — 3D atomic coordinates and protein metadata
disulfide Disulfide bond data — cysteine connectivity in protein structures
verse Scripture/verse — Book → Chapter → Verse hierarchy and cross-references
person Personal knowledge — biographical and relational graphs
legal Legal corpus — statutory codes and regulations (TBD)

Corpus Abstractions

Generic Corpus — A named collection of any KG instances grouped for scoped federated queries. Useful for project-level or thematic groupings (e.g., "KGRAG_repos" combining code + doc KGs).

Person Corpus — A corpus enriched with personal metadata representing an individual. Aggregates all KGs relevant to a person — diaries, memories, documents, agent sessions, and more — alongside structured personal data (birth year, address, email, contact info).


Features

  • Multi-domain federation — Query code, docs, metabolic pathways, diary entries, and conversation history simultaneously
  • Five-method adapter protocolis_available, query, pack, stats, analyze; add a new domain by implementing five methods
  • Unified registry — Persistent SQLite-backed storage of KG locations, metadata, corpora, and person records
  • Corpus abstraction — Group KGs into named corpora for scoped federated queries
  • Person corpus — Model individuals with personal metadata and their associated KG collections
  • Hybrid querying — Semantic seeding via LanceDB + structural BFS traversal
  • Context packing — Extract source-grounded snippets with line numbers for direct LLM ingestion
  • MCP server — 22 tools exposing registry, corpus, and person operations to any MCP-compatible agent
  • CLI tooling — Full CRUD for KGs, corpora, and person corpora; query, pack, analyze, synthesize
  • Streamlit dashboard — Interactive browser for exploring and querying registered knowledge graphs
  • Deterministic retrieval — Auditable, source-grounded results; zero hallucination at the knowledge layer

Quick Start

pip install kg-rag

# With Streamlit dashboard
pip install 'kg-rag[viz]'

# With PyCodeKG / DocKG / FTreeKG adapters
pip install 'kg-rag[kg]'

# With git-sourced adapters (AgentKG, DiaryKG, MetaboKG, MemoryKG) — Poetry only
poetry install --with kgdeps
# Register a Python codebase
kgrag register my-code code /path/to/my-repo

# Federated query across all registered KGs
kgrag query "authentication flow"

# Snippet pack for LLM ingestion
kgrag pack "database connection setup" --out context.md

# Launch the dashboard
kgrag viz

Full installation guide · Usage guide · CLI reference


MCP Integration

KGRAG ships a built-in MCP server exposing 22 tools to any MCP-compatible agent (Claude Code, Cursor, GitHub Copilot, Claude Desktop):

kgrag mcp
{
  "mcpServers": {
    "kgrag": {
      "command": "/path/to/venv/bin/kgrag",
      "args": ["mcp"]
    }
  }
}

Tools span three groups: core KG (kgrag_stats, kgrag_list, kgrag_info, kgrag_query, kgrag_pack), corpus (8 tools), and person corpus (9 tools).

Full MCP reference


Documentation

Document Description
Technical Paper Architecture, design principles, and formal treatment
Manifesto The case for Structurally-Grounded Synthetic Intelligence
Installation Guide Prerequisites, venv setup, extras
Usage Guide Workflows, patterns, and examples
CLI Reference Complete command reference
MCP Reference Tool reference and agent configuration
Adapter Spec Five-method protocol for new backends
Troubleshooting Common issues and fixes

Related Projects

Project Description
PyCodeKG Deterministic knowledge graph for Python codebases
DocKG Semantic knowledge graph for document corpora
MetaboKG Metabolic pathway knowledge graph
DiaryKG Diary and personal journal corpus knowledge graph
AgentKG Conversational memory knowledge graph
FTreeKG File system tree knowledge graph
MemoryKG Episodic memory knowledge graph for conversation and event corpora
GutenbergKG Project Gutenberg book corpus knowledge graph
IABookKG Internet Archive book corpus knowledge graph (under development)

License

Elastic License 2.0 — see LICENSE.

Free to use, modify, and distribute. You may not offer the software as a hosted or managed service to third parties. Commercial internal use is permitted.

If you use KGRAG in research, please cite: DOI

The Knowledge Compiler concept and its execution are the subject of a pending U.S. provisional patent application.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kg_rag-0.9.1.tar.gz (105.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kg_rag-0.9.1-py3-none-any.whl (134.1 kB view details)

Uploaded Python 3

File details

Details for the file kg_rag-0.9.1.tar.gz.

File metadata

  • Download URL: kg_rag-0.9.1.tar.gz
  • Upload date:
  • Size: 105.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.12.13 Darwin/25.4.0

File hashes

Hashes for kg_rag-0.9.1.tar.gz
Algorithm Hash digest
SHA256 874026f76f57e95df37bb3008c80f29d182f4dd8fbbdf03a666ce65538ccb037
MD5 007877c2eca4a4b81f89c7e7627de2bb
BLAKE2b-256 5a22b80b72f03a43d5a84f1f7c2f048fff32cba77d3b37e32c9ddf0a9b04f6d1

See more details on using hashes here.

File details

Details for the file kg_rag-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: kg_rag-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 134.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.12.13 Darwin/25.4.0

File hashes

Hashes for kg_rag-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 177d3303098aa39fc3998875e013630664295b041d88ca5d6211c2a551c6d095
MD5 de92d81af3d9b296e163d699942c15d1
BLAKE2b-256 9b9b6be9c6db1d8e18dde54ae3c88662ecddba92086fd950063dd880c46ab8a8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page