leankg 0.14.2

Lightweight Knowledge Graph for AI-Assisted Development
Documentation
# LeanKG Architecture

## System Design

### C4 Model - Level 2: Component Diagram

```mermaid
graph TB
    subgraph "Developer Machine"
        subgraph "LeanKG System"
            direction TB
            CLI["CLI<br/>init, index, serve, watch"]

            subgraph "Indexer"
                Parser["Parser<br/>(tree-sitter)"]
                Extractor["Extractor<br/>functions, classes, imports, calls"]
            end

            DB[("CozoDB<br/>SQLite")]

            subgraph "MCP Server"
                Tools["MCP Tools<br/>search, query, impact, context"]
            end

            subgraph "Web UI"
                Graph["Graph Viewer<br/>sigma.js"]
                API["REST API<br/>/api/graph/data"]
            end
        end

        AI["AI Tool<br/>(Claude, Cursor, OpenCode)"]
    end

    CLI -->|init| DB
    CLI -->|index| Parser
    Parser -->|parse| Extractor
    Extractor -->|store| DB
    CLI -->|serve| MCP
    DB -->|query| Tools
    Tools -->|MCP| AI
    CLI -->|web| API
    API -->|fetch| Graph
    Extractor -->|watch| CLI
```

### Data Flow

```mermaid
graph LR
    subgraph "1. Index Phase"
        A["Source Code<br/>*.rs, *.ts, *.py, *.go, *.java, *.kt"] --> B["tree-sitter Parser"]
        B --> C["Code Elements<br/>functions, classes"]
        B --> D["Relationships<br/>imports, calls"]
        C --> E[("CozoDB")]
        D --> E
    end

    subgraph "2. Query Phase"
        E --> F["MCP Tools"]
        F --> G["AI Tool Context<br/>13-42 tokens"]
    end
```

---

## Data Model

### Node Types

| Element Type | Description | Example |
|--------------|-------------|---------|
| `function` | Code functions | `src/auth.rs::validate_token` |
| `class` | Classes and structs | `src/db/models.rs::User` |
| `module` | Files/modules | `src/db/models.rs` |
| `document` | Documentation files | `docs/architecture.md` |
| `doc_section` | Doc headings | `docs/api.md::Usage` |

### Relationship Types

| Type | Direction | Description |
|------|----------|-------------|
| `calls` | A → B | Function A calls function B |
| `imports` | A → B | Module A imports module B |
| `contains` | doc → section | Document contains section |
| `tested_by` | A → B | Code A is tested by test B |
| `documented_by` | A → B | Code A is documented by doc B |

**Key Insight:** The graph stores the FULL dependency graph at indexing time. When you query, LeanKG traverses N hops from your target to find all affected elements - no file scanning needed.

---

## Tech Stack

- **Language:** Rust 1.70+
- **Database:** CozoDB (embedded SQLite)
- **Parser:** tree-sitter
- **MCP Protocol:** Custom implementation
- **Web UI:** Vite + React + TailwindCSS + Sigma.js

### Supported Languages

- Rust
- Go
- TypeScript / JavaScript
- Python
- Java
- Kotlin

---

## Project Structure

```
src/
├── lib.rs              # Module exports
├── db/
│   └── models.rs       # Data models (CodeElement, Relationship)
├── graph/
│   └── query.rs        # Graph query engine
├── mcp/
│   ├── tools.rs        # MCP tool definitions
│   └── handler.rs      # MCP tool handlers
├── indexer/
│   ├── extractor.rs    # Code parsing with tree-sitter
│   └── watcher.rs      # File watching
└── cli/
    └── mod.rs          # CLI commands
```