README - Dynamic Knowledge Base Platform by denissud

Dynamic Knowledge Base Platform

A web application for creating project-specific knowledge bases accessible to Large Language Models (LLMs) via the Model Context Protocol (MCP) standard.

Overview

The Dynamic Knowledge Base Platform enables users to upload documents in various formats, processes and structures the data, and hosts a custom MCP server that allows LLMs to access this information as context for generating more accurate and relevant responses.

Key Features

Document Processing: Upload and process documents in various formats (PDFs, Word docs, text, code, etc.)
Dynamic Context: Continuously update knowledge bases with new or modified documents
MCP Server: Compliant with the Model Context Protocol standard for LLM access
Security: Strong authentication, authorization, and data protection
Responsive UI: Intuitive interface that works on both desktop and mobile devices

Technology Stack

Backend: Go
Frontend: React with TypeScript
Database: PostgreSQL with pgvector extension
Authentication: JWT tokens and API keys
Protocol: Model Context Protocol (MCP)

Project Structure

dynamic_knowledge_base/
├── backend/               # Go backend
│   ├── cmd/               # Application entry points
│   │   └── server/        # Main server application
│   └── internal/          # Internal packages
│       ├── api/           # API handlers and routing
│       ├── auth/          # Authentication and authorization
│       ├── document/      # Document processing
│       ├── knowledge/     # Knowledge base management
│       ├── mcp/           # MCP server implementation
│       └── storage/       # Database and storage
├── frontend/              # React frontend
│   ├── public/            # Static files
│   └── src/               # Source code
│       ├── components/    # React components
│       ├── pages/         # Page components
│       ├── services/      # API services
│       ├── hooks/         # Custom React hooks
│       └── utils/         # Utility functions
├── docs/                  # Documentation
│   ├── architecture_design.md      # System architecture
│   ├── project_documentation.md    # Technical documentation
│   ├── requirements_analysis.md    # Requirements analysis
│   └── user_guide.md               # User guide
└── README.md              # Project overview

Getting Started

Prerequisites

Go 1.18 or higher
Node.js 16 or higher
PostgreSQL 14 or higher with pgvector extension

Backend Setup

Clone the repository
Navigate to the backend directory
Install dependencies:
```
go mod download
```
Run the server:
```
go run cmd/server/main.go
```

Frontend Setup

Navigate to the frontend directory
Install dependencies:
```
npm install
```
Start the development server:
```
npm start
```

Deployment

Backend Deployment

Build the backend:

cd backend
go build -o server cmd/server/main.go

Run the server:
```
./server
```

Frontend Deployment

Build the frontend:
```
cd frontend
npm run build
```
Serve the build directory with a web server of your choice

Documentation

: System architecture and component interactions
: Technical implementation details
: Project requirements and specifications
: Instructions for using the platform

MCP Integration

To connect an LLM to your knowledge base:

Create an MCP connection in the platform UI
Configure your LLM to use the WebSocket endpoint: ws://your-server-address/ws?api_key=YOUR_API_KEY
The LLM will now have access to your project's documents and can use them as context for generating responses