# kaiban-ai/kaibanjs architecture

> Architecture diagram of the GitHub repository kaiban-ai/kaibanjs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kaiban-ai/kaibanjs
- Repository: https://github.com/kaiban-ai/kaibanjs

## Overview

##### Main Components Identification

a) Core Framework Layer:
- Agent System (/src/agents)
- Store Management (/src/stores)
- Task Management
- Team Management
- Workflow Controller

b) Tools Layer (/packages/tools):
- Search Tools (serper, tavily, website-search)
- Document Processing (pdf-search, textfile-search)
- Integration Tools (github-issues, zapier-webhook)
- RAG Implementation (simple-rag)

c) Integration Layer:
- LLM Providers Support (OpenAI, Anthropic, Google, etc.)
- Framework Compatibility (React, Node.js)
- External Tool Integration

**[Client Applications]**
- ↑↓
**[KaibanJS Core Framework]**

- [Agent System]--|
- [Store System]--|
- [Task System]---|
- [Team System]---|

- ↑↓
**[Tools Layer]**

- [Search Tools]
- [Document Tools]
- [Integration Tools]
- [RAG Tools]

- ↑↓
**[LLM Integration Layer]**

- [OpenAI]
- [Anthropic]
- [Google]
- [Others]

##### Component Relationships

**[Agent Store] ←→ [Task Store] ←→ [Team Store]**
- ↑               ↑              ↑

**[Workflow Controller]------------------'**

**[Agent] → [Tool Manager] → [Specific Tool Implementation]**
- ↓
- [External Service/API]

**[Workflow Events] → [Subscribers] → [State Updates]**

##### Implementation Details to Highlight

- Redux-inspired state management architecture
- Event-driven communication between components
- Pluggable tool architecture
- Framework-agnostic core with framework-specific bindings
- Real-time monitoring and logging system

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef core fill:#2196F3,color:white
    classDef tools fill:#4CAF50,color:white
    classDef integration fill:#FF9800,color:white
    classDef external fill:#9C27B0,color:white
    classDef client fill:#757575,color:white

    %% Client Layer
    subgraph ClientLayer
        Client[Client Applications]:::client
    end

    %% Core Framework Layer
    subgraph CoreFramework
        AgentSystem["Agent System"]:::core
        StoreSystem["Store Management"]:::core
        TaskSystem["Task Management"]:::core
        TeamSystem["Team Management"]:::core
        WorkflowCtrl["Workflow Controller"]:::core

        %% Store Components
        AgentStore["Agent Store"]:::core
        TaskStore["Task Store"]:::core
        TeamStore["Team Store"]:::core

        %% Agent Components
        BaseAgent["Base Agent"]:::core
        ReActAgent["ReAct Agent"]:::core
    end

    %% Tools Layer
    subgraph ToolsLayer
        SearchTools["Search Tools"]:::tools
        DocTools["Document Tools"]:::tools
        IntegTools["Integration Tools"]:::tools
        RAGTools["RAG Tools"]:::tools

        %% Search Tool Components
        Serper["Serper"]:::tools
        Tavily["Tavily"]:::tools
        WebSearch["Website Search"]:::tools

        %% Document Tool Components
        PDFSearch["PDF Search"]:::tools
        TextSearch["Text File Search"]:::tools

        %% Integration Tool Components
        GithubIssues["GitHub Issues"]:::tools
        ZapierWebhook["Zapier Webhook"]:::tools

        %% RAG Components
        SimpleRAG["Simple RAG"]:::tools
        RAGUtils["RAG Utilities"]:::tools
    end

    %% Integration Layer
    subgraph LLMLayer
        OpenAI["OpenAI"]:::integration
        Anthropic["Anthropic"]:::integration
        Google["Google"]:::integration
        Mistral["Mistral"]:::integration
    end

    %% Utility Components
    subgraph Utils
        Logger["Logger"]:::core
        ErrorHandler["Error Handler"]:::core
        CostCalc["Cost Calculator"]:::core
    end

    %% Relationships
    Client <--> CoreFramework
    CoreFramework <--> ToolsLayer
    ToolsLayer <--> LLMLayer

    AgentSystem --> BaseAgent
    AgentSystem --> ReActAgent
    
    StoreSystem --> AgentStore
    StoreSystem --> TaskStore
    StoreSystem --> TeamStore
    
    WorkflowCtrl --> AgentStore
    WorkflowCtrl --> TaskStore
    WorkflowCtrl --> TeamStore

    SearchTools --> Serper
    SearchTools --> Tavily
    SearchTools --> WebSearch

    DocTools --> PDFSearch
    DocTools --> TextSearch

    IntegTools --> GithubIssues
    IntegTools --> ZapierWebhook

    RAGTools --> SimpleRAG
    RAGTools --> RAGUtils

    %% Click Events
    click AgentSystem "https://github.com/kaiban-ai/KaibanJS/tree/main//src/agents"
    click BaseAgent "https://github.com/kaiban-ai/KaibanJS/blob/main//src/agents/baseAgent.js"
    click ReActAgent "https://github.com/kaiban-ai/KaibanJS/blob/main//src/agents/reactChampionAgent.js"
    click AgentStore "https://github.com/kaiban-ai/KaibanJS/blob/main//src/stores/agentStore.js"
    click TaskStore "https://github.com/kaiban-ai/KaibanJS/blob/main//src/stores/taskStore.js"
    click TeamStore "https://github.com/kaiban-ai/KaibanJS/blob/main//src/stores/teamStore.js"
    click WorkflowCtrl "https://github.com/kaiban-ai/KaibanJS/blob/main//src/stores/workflowController.js"
    click Serper "https://github.com/kaiban-ai/KaibanJS/tree/main//packages/tools/src/serper"
    click Tavily "https://github.com/kaiban-ai/KaibanJS/tree/main//packages/tools/src/tavily"
    click WebSearch "https://github.com/kaiban-ai/KaibanJS/tree/main//packages/tools/src/website-search"
    click PDFSearch "https://github.com/kaiban-ai/KaibanJS/tree/main//packages/tools/src/pdf-search"
    click TextSearch "https://github.com/kaiban-ai/KaibanJS/tree/main//packages/tools/src/textfile-search"
    click GithubIssues "https://github.com/kaiban-ai/KaibanJS/tree/main//packages/tools/src/github-issues"
    click ZapierWebhook "https://github.com/kaiban-ai/KaibanJS/tree/main//packages/tools/src/zapier-webhook"
    click SimpleRAG "https://github.com/kaiban-ai/KaibanJS/tree/main//packages/tools/src/simple-rag"
    click RAGUtils "https://github.com/kaiban-ai/KaibanJS/tree/main//packages/tools/src/_utils/rag"
    click OpenAI "https://github.com/kaiban-ai/KaibanJS/blob/main//playground/react/src/teams/llms/openai.js"
    click Anthropic "https://github.com/kaiban-ai/KaibanJS/blob/main//playground/react/src/teams/llms/anthropic.js"
    click Google "https://github.com/kaiban-ai/KaibanJS/blob/main//playground/react/src/teams/llms/gemini.js"
    click Mistral "https://github.com/kaiban-ai/KaibanJS/blob/main//playground/react/src/teams/llms/mistral.js"
    click Logger "https://github.com/kaiban-ai/KaibanJS/blob/main//src/utils/logger.js"
    click ErrorHandler "https://github.com/kaiban-ai/KaibanJS/blob/main//src/utils/errors.js"
    click CostCalc "https://github.com/kaiban-ai/KaibanJS/blob/main//src/utils/llmCostCalculator.js"
```
