Skip to main content

Supported Platforms

Currently supports binary deployment for the following platforms:

Linux AMD64

Suitable for x86_64 architecture Linux systems

Linux ARM64

Suitable for ARM64 architecture Linux systems
You can view and download the latest binary files at GitHub Releases.

Deployment Steps

1

Create Directory and Download Configuration

2

Adjust PID File Path (macOS Users)

On macOS, /var/run/mcp-gateway.pid may not have write permissions, so the path needs to be adjusted.
3

Download Binary Files

Choose the appropriate binary file based on your system architecture:Linux AMD64:
Linux ARM64:
4

Start Service

Configuration Guide

Environment Variables File

The downloaded .env file contains all necessary configuration items. Main configurations include:
Configure database connection information for storing chat messages and gateway configurations
Configure notification methods for configuration updates (signal, api, redis, etc.)
Configure JWT secret keys and super admin account information

Configuration Files

  • configs/apiserver.yaml: API server configuration
  • configs/mcp-gateway.yaml: MCP Gateway core configuration
For detailed configuration instructions, please refer to the Configuration Documentation.

Notes

Binary deployment requires you to manage service startup, stop, and monitoring yourself. It is recommended to use process management tools such as systemd or supervisor in production environments.

systemd Service Configuration Example

You can create a systemd service file to manage MCP Gateway:
Save this file as /etc/systemd/system/mcp-gateway.service, then:

Firewall Configuration

Ensure the following ports are accessible:
  • 5235: MCP Gateway main service port
  • 5335: Management port (internal access only)
If you need a Web management interface, it is recommended to deploy API Server and Web frontend simultaneously, or use the All-in-One Docker deployment method.