Project Setup Guide

🚀 Project Setup Guide

This guide will walk you through the process of setting up the front - end and back - end environments for the project.

🚀 Quick Start

📦 Installation for Back - end

1. Navigate to the backend directory.

   cd backend
   

2. Run the following command to install the required dependencies:

   npm install
   

3. Create a .env file in the backend folder and add the following environment variables:

   PORT=5000
   FRONTEND_URL=http://localhost:5173
   

4. Start the server using the following command:

   npm run dev
   

   The server will now be running at http://localhost:5000.

📦 Installation for Front - end

1. Navigate to the frontend directory.

   cd frontend
   

2. Run the following command to install the required dependencies:

   npm install
   

3. Create a .env file in the frontend folder and add the following environment variable:

   VITE_BACKEND_URL=http://localhost:5000
   

4. Start the client using the following command:

   npm run dev
   

   The client will now be running at http://localhost:5173.

💡 Usage Tip

• Ensure that both the front - end and back - end are running simultaneously.
• Make sure that both the front - end and back - end servers are started and running before accessing http://localhost:5173.

💻 Usage Examples

MCP Server Check API

This is a simple Node.js Express endpoint that checks the availability of an MCP server by querying https://registry.smithery.ai/servers/{installationCode} using the installationCode parameter in the request body. The server returns corresponding response information based on whether the connection is successful.

API Interface

POST /test-server

Request Body

{
  "installationCode": "your-installation-code"
}

Response

{
  "success": true,
  "message": "MCP Server is reachable",
  "data": {
    "qualifiedName": "server-qualified-name",
    "displayName": "Server Display Name",
    "deploymentUrl": "https://deployment-url.com",
    "connections": [
      {
        "type": "http",
        "url": "https://connection-url.com",
        "configSchema": {}
      }
    ]
  }
}

📚 Documentation

For more detailed information, please visit Smithery Registry Documentation.