Skip to content

QUICKSTART.md

Latest commit

 

History

History
157 lines (116 loc) · 2.76 KB

QUICKSTART.md

File metadata and controls

157 lines (116 loc) · 2.76 KB
Raw

Quick Start Guide - MCP Unified Hub

Get up and running in 5 minutes!

Step 1: Prepare Environment (2 min)

  1. Make sure Docker Desktop is running
  2. Open a terminal and navigate to the MCP Hub directory: 
    cd C:\Users\momo-\mcp-hub

Step 2: Configure API Keys (2 min)

  1. Copy the environment template:

    # Windows
copy .env.template .env

# Linux/Mac
cp .env.template .env

  2. Edit .env and add your API keys:

    # Windows
notepad .env

# Linux/Mac
nano .env

  3. Minimum required (for basic functionality):

    • Set database passwords (change defaults for security)
    • Add API keys only for services you plan to use

    Not all API keys are required! The hub will work with whatever you configure.

Step 3: Start the Hub (1 min)

Windows

start.bat

Linux/Mac

chmod +x start.sh
./start.sh

The script will:

  • Check Docker is running
  • Start all services
  • Show you the service URLs

Step 4: Verify It's Working (30 seconds)

Open your browser or use curl:

# Check health
http://localhost:3100/health

# View available tools
http://localhost:3100/tools

# Access MindsDB
http://localhost:47334

Step 5: Connect Your IDE (30 seconds)

For Claude Code:

claude mcp add --transport http mcp-hub http://localhost:3100/mcp

For VSCode/Cursor:

Add to settings.json:

{
  "mcp.servers": {
    "unified-hub": {
      "type": "http",
      "url": "http://localhost:3100/mcp"
    }
  }
}

You're Done!

You now have:

  • ✅ A unified MCP gateway at http://localhost:3100
  • ✅ MindsDB running at http://localhost:47334
  • ✅ PostgreSQL, MongoDB, Redis ready to use
  • ✅ 25+ MCP services available
  • ✅ Connected to your favorite IDE

Next Steps

  1. Test a tool from your IDE (e.g., "search my Notion workspace")
  2. Configure more services by adding API keys to .env
  3. Explore MindsDB for AI/ML capabilities
  4. Check the README.md for advanced features

Quick Commands

# View logs
docker-compose logs -f

# Check status
docker-compose ps

# Stop the hub
stop.bat      # Windows
./stop.sh     # Linux/Mac

# Restart after config changes
docker-compose restart

Troubleshooting

"Port already in use"

Change the port in docker-compose.yml:

ports:
  - "3101:3100"  # Use 3101 instead of 3100

"Service won't start"

Check the logs:

docker-compose logs [service-name]

"API key not working"

  1. Verify the key in .env
  2. Restart the service: 
    docker-compose restart mcp-gateway

Need Help?

  • 📖 Full documentation: README.md
  • 🐛 Report issues: GitHub Issues
  • 💬 Ask questions: GitHub Discussions

Happy coding with MCP Unified Hub! 🚀