Architecture Diagrams
High-level architecture diagrams for the Connector module. These diagrams provide an overview of the system's structure, components, and their relationships.
Diagrams
block-diagram.md - High-level architecture overview
API Layer: REST API and MCP Tools for external interfaces
Connector Engine: ConnectorService, BosaService, and AIPAgentService for core business logic
Infrastructure: Authentication, WebSocket Event Emitter, and User Storage for security, real-time communication, and credential management
External Services: BOSA Service for connector integrations and AIP API for agent execution
Shows component relationships and data flow between layers
class-diagram.md - Simplified class structure
Shows core classes: ConnectorService, BosaService, AIPAgentService, ConfigurationService, AipService, ProcessingService
Displays essential relationships, dependencies, and interactions
Focuses on main public methods and key interactions
Illustrates how services work together to manage connectors and execute queries
Usage
These diagrams can be viewed:
In any Markdown viewer that supports Mermaid (GitHub, GitLab, etc.)
In VS Code with the Mermaid extension
Online at https://mermaid.live/
In documentation tools like MkDocs, Docusaurus, etc.
Updating Diagrams
When updating the codebase, please update the relevant diagrams to reflect architectural changes. The diagrams should be kept in sync with the implementation.
Last updated