Skip to content

Getting Started

Jump to bottom
RealmsNetwork edited this page Oct 20, 2026 · 1 revision

Getting Started

For long-running deployments, also read Deployment.

Requirements

  • Python 3.11 or newer.
  • An MCP-compatible client.
  • HTTPS connectivity to each panel API.
  • Credentials with the permissions required for planned actions.

Install from source

Clone the public repository and create a virtual environment:

git clone https://github.com/RealmsNetwork/MAP.git
cd MAP
python -m venv .venv

Linux/macOS:

. .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e '.[dev]'

Windows PowerShell:

.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install -e '.[dev]'

Run tests and a compile check:

python -m pytest -q
python -m compileall -q src

Configure panels

Use the tracked .env.example and current README as the canonical variable reference. Do not place real credentials in tracked files. For multiple panels, use the multi-panel configuration supported by your installed version. Each panel should have a unique ID, HTTPS base URL, provider type where applicable, and provider-appropriate credentials.

An API key can only grant the permissions provided by the panel. A Pterodactyl Client key is not interchangeable with an Application or Admin key.

Run MAP

The package entry point is map-server. The HTTP server defaults to loopback on port 8765 in the current configuration. Configure the MCP client for the chosen transport and consult the repository README for current transport details.

Do not bind MAP to a public interface without authentication and TLS-protected ingress. For details, see Security.

First checks

  1. Call list_panels and confirm the expected IDs and providers.
  2. Confirm authentication readiness is reported without showing key values.
  3. Run a harmless read operation first.
  4. Test write, power, console, and delete operations only on a disposable server.

Upgrade

Review the changelog and release notes. Back up configuration securely, install a reviewed release/commit, run tests, restart the service, and verify read and write actions against a test server.

Clone this wiki locally