DocumentationNeuronMCP Documentation
Documentation Branch: You are viewing documentation for the main branch (3.0.0-devel). Select a branch to view its documentation:
NeuronMCP Installation
Docker Installation
The fastest way to get NeuronMCP running is with Docker Compose.
Start NeuronMCP with Docker Compose
# Clone repository
git clone https://github.com/neurondb-ai/neurondb.git
cd neurondb
# Start NeuronMCP with NeuronDB
docker compose up -d neuronmcp neurondb
# Verify services
docker compose psSource Build
For production deployments or custom builds, install from source. This requires Go 1.21+, PostgreSQL 16-18 with NeuronDB extension, and build dependencies.
Build from source (Ubuntu/Debian)
# Install dependencies
sudo apt-get install -y postgresql-17 postgresql-server-dev-17 build-essential golang-go
# Clone repository
git clone https://github.com/neurondb-ai/neurondb.git
cd neurondb
# Build NeuronMCP
cd NeuronMCP
go build -o neuronmcp ./cmd/server
# Run setup script to configure database schema
./scripts/neuronmcp-setup.sh
# Run NeuronMCP server
./neuronmcp --transport stdioConfiguration
Configure NeuronMCP to connect to your NeuronDB instance and set up the configuration schema. See the Setup Guide for complete instructions.
Verification
Verify NeuronMCP is running correctly:
Test MCP server
# Test stdio mode
echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}' | ./neuronmcp