Get Started Locally

Set Up Locally

1. Clone the repository and install dependencies for mcpx-server:

git clone https://github.com/TheLunarCompany/lunar.git
cd lunar/mcpx
npm install

2. Build:

npm run build:deps

3. Run the server:

cd packages/mcpx-server
npm run dev

4. Create one configuration file to manage all your MCP servers:

• Clone the Github Repository
• Navigate to /lunar/mcpx/packages/mcpx-server/.
• Create the config directory mkdir config.
• Navigate to config folder using cd config.
• Create a configuration file mcp.json.
• MCPX will use the /lunar/mcpx/packages/mcpx-server/config/mcp.json file for centralized configuration management.

5. Copy the following configuration example into mcp.json:

{
  "mcpServers": {
    "time": {
      "command": "uvx",
      "args": ["mcp-server-time", "--local-timezone=America/New_York"]
    }
  }
}

This configuration uses a single MCP server, mcp-server-time, that requires no credentials, for quick-start set up.

note

• MCPX runs by default on port 9000, or via a custom port supplied via the PORT environment variable.
• MCPX loads a general configuration file listing general application configuration at mcpx-server/config/app.yaml which can be changed using the APP_CONFIG_PATH environment variable.

Congratulations!

You have now set up your MCPX. You should see the following lines to indicate a successful installation:

Starting mcpx server... ⚡️ 
Server started on port 9000 

Metrics

Metrics are automatically exposed on port 3000 which is used for Prometheus metrics scraping. It can be accessed at http://localhost:3000/

Control Plane

You can access the MCPX Control Plane local installation instructions here.

Once you have an instance running you can navigate to http://localhost:5173/ in your preferred browser.