Getting Started with NeuronDesktop

Introduction

NeuronDesktop is a unified web interface providing a single dashboard for managing and interacting with MCP servers, NeuronDB, and NeuronAgent. It includes:

• Unified Dashboard - Single interface for managing all NeuronDB ecosystem components with profile-based configuration
• Real-Time Updates - WebSocket support for live updates, streaming responses, and instant feedback
• NeuronDB Management - Browse tables, run queries, manage indexes, and perform vector searches through intuitive UI
• Agent Management - Create agents, view sessions, monitor performance, and test agent interactions
• MCP Integration - Full MCP server integration and testing through the web interface
• Metrics & Monitoring - Built-in metrics collection, health checks, and performance dashboards

What you can build: A complete management interface for your NeuronDB ecosystem with real-time monitoring, query execution, agent management, and MCP tool testing - all in one unified web application.

Choose Your Path

Pick the installation method that best fits your needs:

Docker Quick Start

Complete NeuronDesktop setup running in under 5 minutes with Docker Compose. This method includes the web interface with API backend.

# Clone repository (main branch = 3.0.0-devel)
git clone https://github.com/neurondb-ai/neurondb.git
cd neurondb

# For stable 1.0.0 release, checkout REL1_STABLE branch:
# git checkout REL1_STABLE

# Start NeuronDesktop with NeuronDB
docker compose up -d neurondesk-api neurondesk-frontend neurondb

# Verify services
docker compose ps

# Access web interface
# API: http://localhost:8081/
# UI: http://localhost:3000/

This starts:

• NeuronDesktop API on port 8081
• NeuronDesktop Frontend (Web UI) on port 3000
• NeuronDB (PostgreSQL with extension) on port 5433
• WebSocket support for real-time updates

Continue to Profile Configuration →

Profile Configuration

NeuronDesktop uses profiles to manage connections to different environments and components. Create your first profile to connect to NeuronDB, NeuronAgent, and NeuronMCP.

# Create a profile via API
curl -X POST http://localhost:8081/api/v1/profiles \
  -H "Content-Type: application/json" \
  -d '{
    "name": "default",
    "neurondb": {
      "host": "localhost",
      "port": 5433,
      "database": "neurondb",
      "user": "postgres",
      "password": "postgres"
    },
    "neuronagent": {
      "url": "http://localhost:8080",
      "apiKey": "your-api-key"
    },
    "neuronmcp": {
      "command": "neuronmcp",
      "args": ["--transport", "stdio"]
    }
  }'

Profile features:

• Multiple environment support (development, staging, production)
• Auto-detection of components
• Connection string management
• API key and authentication configuration

See the Profile Configuration Guide for detailed instructions.

Source Build (Advanced)

For production deployments or custom builds, install from source. This requires Node.js 18+, Go 1.21+, and build dependencies.

See the Installation Guide for detailed platform-specific instructions.

# Install dependencies
sudo apt-get install -y nodejs npm golang-go build-essential

# Clone repository
git clone https://github.com/neurondb-ai/neurondb.git
cd neurondb

# For stable 1.0.0 release, checkout REL1_STABLE branch:
# git checkout REL1_STABLE

# Build API
cd NeuronDesktop/api
go build -o neurondesk-api ./cmd/server

# Build Frontend
cd ../frontend
npm install
npm run build

# Run API
cd ../api
./neurondesk-api --config configs/config.yaml.example

# Run Frontend (in another terminal)
cd ../frontend
npm run start

After building NeuronDesktop, configure it to connect to your NeuronDB, NeuronAgent, and NeuronMCP instances. See the Profile Configuration Guide for details.

Next Steps

After installation, use these guides:

• Profile Configuration - Create and manage profiles for multiple environments
• Features Documentation - Complete feature reference for dashboard, console, and management
• NeuronDB Documentation - Vector search, ML inference, and RAG pipelines
• NeuronAgent Documentation - AI agent runtime with REST API and WebSocket
• NeuronMCP Documentation - MCP server with 100+ tools