MCP Brain Server

🚀 Brain Server Guide

The Brain Server is a knowledge embedding service based on the Model Context Protocol (MCP). It offers various functions, including vector embedding, semantic search, and knowledge management. This guide will provide detailed instructions on how to use and deploy the server.

🚀 Quick Start

This guide will walk you through the installation, usage, and project structure of the Brain Server.

✨ Features

• Vector embedding
• Semantic search
• Knowledge management

📦 Installation

Install with Docker

docker build -t mcp-brain-server .
docker run -p 3000:3000 -d --name brain-server mcp-brain-server

Manual Installation

1. Clone the repository:

   git clone https://github.com/your-repository.git
   cd mcp-brain-server
   

2. Install dependencies:

   npm install
   

3. Start the server:

   npm start
   

💻 Usage Examples

Available Resources

• embedding_config: Current embedding configuration
• embedding_models: Available embedding models and their configurations
• service_status: Status of the embedding service

Tool Examples

Add Knowledge

{
  "content": "The Model Context Protocol (MCP) is a standard interface for AI models to interact with external systems.",
  "metadata": {
    "brainId": "tech-knowledge",
    "userId": "user123",
    "source": "Document",
    "type": "Definition"
  }
}

Search for Similar Content

{
  "query": "What is MCP?",
  "options": {
    "limit": 5,
    "minConfidence": 0.7,
    "filters": {
      "metadata.brainId": "tech-knowledge"
    }
  }
}

📚 Documentation

Project Structure

src/
├── config/          # Configuration settings
├── controllers/     # Route controllers
├── errors/          # Error definitions
├── middleware/      # Express middleware
├── models/          # Data models and types
├── services/        # Business logic
│   ├── embeddings/  # Embedding providers
│   ├── ingestion/   # Knowledge ingestion
│   ├── processing/  # Knowledge processing
│   └── storage/     # Storage services
├── tools/           # MCP tool definitions
├── types/           # TypeScript type definitions
├── utils/           # Utility functions
├── server.ts        # MCP server setup
└── index.ts         # Application entry point

Script Commands

• npm run build: Build the TypeScript project
• npm start: Run the built application
• npm run dev: Run in development mode with hot reloading
• npm test: Run tests
• npm run lint: Run the code linter