Skip to content

STARTUP.md

Latest commit

 

History

History
112 lines (77 loc) · 3.64 KB

STARTUP.md

File metadata and controls

112 lines (77 loc) · 3.64 KB

Multi-Agent Canvas Startup Guide

This document provides instructions for starting and stopping the Multi-Agent Canvas application, which consists of a frontend (Next.js) and a backend (MCP Agent).

Prerequisites

Before starting the application, ensure you have the following installed:

  • Poetry for Python dependency management
  • PNPM for Node.js dependency management
  • Node.js (v18 or later)
  • Python (v3.10 or later)

Starting the Application

You have two options for starting the application:

Option 1: Using the Batch Script (Windows)

  1. Double-click the start-app.bat file
  2. Two command windows will open - one for the backend and one for the frontend
  3. Wait for both services to initialize

Option 2: Using the PowerShell Script (Recommended)

  1. Right-click on start-app.ps1 and select "Run with PowerShell"
  2. The script will:
    • Check if all prerequisites are installed
    • Start the backend and verify it's running
    • Start the frontend and verify it's running
    • Verify the integration between frontend and backend
    • Display the URLs for accessing the application

Accessing the Application

Once both services are running, you can access:

Stopping the Application

You have two options for stopping the application:

Option 1: Using the Batch Script (Windows)

  1. Double-click the stop-app.bat file
  2. The script will terminate all related processes

Option 2: Using the PowerShell Script (Recommended)

  1. Right-click on stop-app.ps1 and select "Run with PowerShell"
  2. The script will:
    • Identify and stop all frontend processes
    • Identify and stop all backend processes
    • Close any remaining terminal windows

Troubleshooting

If you encounter issues:

  1. Backend fails to start:

    • Check if port 8123 is already in use
    • Verify that Poetry is installed correctly
    • Check the backend terminal for specific error messages

  2. Frontend fails to start:

    • Check if port 3000 is already in use
    • Verify that PNPM is installed correctly
    • Check the frontend terminal for specific error messages

  3. Connection issues:

    • Verify that both services are running
    • Check that the frontend's .env file contains NEXT_PUBLIC_BACKEND_URL=http://localhost:8123
    • Try accessing the backend health endpoint directly: http://localhost:8123/health
    • Run the health check script: scripts/check-app-health.ps1 or scripts/check-app-health.bat

Manual Startup (If Scripts Fail)

If the scripts don't work for any reason, you can start the services manually:

Backend (MCP Agent)

cd agent
poetry install
poetry run custom-server

Frontend (Next.js)

cd frontend
pnpm install
pnpm run dev

Script Organization

All utility scripts are now organized in the scripts directory for better maintainability:

  • Start Scripts: scripts/start-app.ps1 and scripts/start-app.bat
  • Stop Scripts: scripts/stop-app.ps1 and scripts/stop-app.bat
  • Health Check Scripts: scripts/check-app-health.ps1 and scripts/check-app-health.bat

For convenience, shortcut scripts are provided in the root directory:

  • start-app.ps1 and start-app.bat
  • stop-app.ps1 and stop-app.bat
  • check-health.ps1 and check-health.bat