Edgegap

Deploy and operate multiplayer game servers on Edgegap's global edge network.

Sollte ich dies verwenden

Qualität und Sicherheit

B
Qualität der Beschreibung
98%
Vollständigkeit des Schemas
91%
Qualität der Benennung
79%
Risiko der Vergiftung
60%
Übereinstimmung der Berechtigungen
100%
Einhaltung des Protokolls
100%

Befunde (7)

  • HIGHTool poisoning patterns detected
  • MEDIUMTool 'edgegap_create_app_version' description contains placeholder textin edgegap_create_app_version
  • MEDIUMTool 'edgegap_update_app_version' description contains placeholder textin edgegap_update_app_version
  • LOWTool 'edgegap_get_registry_credentials' name length outside 3-30 rangein edgegap_get_registry_credentials
  • LOWTool 'edgegap_build_matchmaker_config' name length outside 3-30 rangein edgegap_build_matchmaker_config
  • INFOTool description contains placeholder or incomplete textin edgegap_create_app_version
  • INFOTool description contains placeholder or incomplete textin edgegap_update_app_version

Basierend auf einer automatisierten Analyse der Tool-Definitionen und der Einhaltung des Protokolls.

Kontextkosten

~12,425Tokens (Tool-Definitionen)
~3.1 KBTypische Antwortgröße
Erhebliche Auswirkung auf die Aufmerksamkeit (9.71% von 128k Kontext)

Dies ist die ungefähre Anzahl der Tokens, die jedes Mal verbraucht werden, wenn die Tools des Servers in den Kontext eines Modells geladen werden. Höhere Werte verringern die Aufmerksamkeit, die für andere Aufgaben verfügbar ist.

Installieren

Installation mit einem Klick

Fügen Sie dies Ihrer Datei `claude_desktop_config.json` hinzu:

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "@edgegap/mcp"
      ]
    }
  }
}

Ausführbare Pakete

npm@edgegap/mcp0.19.0stdio

Remote-Endpunkte

https://mcp.edgegap.dev/mcpstreamable-http

Was es kann

Tool-Inventar

Tools (32)

🟢 Nur lesen🟡 Schreiben🔴 Löschen⚪ Unbekannt
🟢edgegap_context(check_token)

Report which Edgegap API this server talks to, its version, whether it is the local or hosted server, and the guardrails in force: read-only mode, application allowlist, max_duration ceiling, the agent deployment cap, the tag forced onto every deployment, and which tools support dry_run. Also says whether this session has a usable token and, if not, why and how to fix it. Call it first when unsure what this session is allowed to do, before anything billable, or when tool calls fail with a token problem. Makes no API call unless check_token is true, and never shows the token.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "check_token": {
      "description": "Make one read-only API call (list one application) to confirm Edgegap accepts the token. Default false.",
      "type": "boolean"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "server": {
      "type": "string"
    },
    "transport": {
      "type": "string"
    },
    "api_host": {
      "type": "string"
    },
    "api_base_url": {
      "type": "string"
    },
    "read_only": {
      "type": "boolean"
    },
    "max_duration_ceiling_minutes": {
      "type": "number"
    },
    "skills_pack": {
      "type": "string"
    },
    "forced_deploy_tag": {
      "type": "string"
    },
    "guardrails": {
      "type": "object",
      "properties": {},
      "additionalProperties": {}
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢edgegap_list_apps(limit, page)

List the applications in the Edgegap organization. Start here before creating or deploying anything, so you reuse an existing application instead of making a duplicate. An "application" groups versions of one game server.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "limit": {
      "description": "Results per page, 1-100. Default 50.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "total": {
      "type": "number"
    },
    "showing": {
      "type": "number"
    },
    "truncated": {
      "type": "boolean"
    },
    "next_step": {
      "type": "string"
    },
    "applications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "active": {
            "type": "boolean"
          },
          "last_updated": {
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟡edgegap_create_app(name, is_active, dry_run)

Create a new application to hold game server versions. Only call this after edgegap_list_apps confirms no suitable application exists. Creating an application does not deploy anything — follow with edgegap_create_app_version.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 3,
      "maxLength": 64,
      "description": "Application name, 3-64 chars. Usually the game or project name."
    },
    "is_active": {
      "description": "Whether deployments are allowed. Default true.",
      "type": "boolean"
    },
    "dry_run": {
      "description": "Show the exact request (method, host, path, body) with secrets masked, and send nothing. Local checks still run. Use it to confirm a billable or destructive call before making it.",
      "type": "boolean"
    }
  },
  "required": [
    "name"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟡edgegap_update_app(application, is_active, dry_run)

Set whether an application accepts new deployments. Turning it off stops new deployments of every version under it; running deployments keep running. Use it to pause an application without deleting anything.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "application": {
      "type": "string",
      "description": "Application name."
    },
    "is_active": {
      "type": "boolean",
      "description": "false blocks new deployments; true allows them again."
    },
    "dry_run": {
      "description": "Show the exact request (method, host, path, body) with secrets masked, and send nothing. Local checks still run. Use it to confirm a billable or destructive call before making it.",
      "type": "boolean"
    }
  },
  "required": [
    "application",
    "is_active"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢edgegap_list_app_versions(application)

List the versions under an application, with their container image, resources, ports (including whether TLS Upgrade is on, which browser/WebGL clients need for wss://) and whether a registry login is set for pulling the image. Use this to find the version name to deploy, to check a version is ready before deploying, or to copy the non-secret settings (image, resources, ports) of a working version when creating a new one. The registry login and secret env values are never readable: the API returns "This value is set and encrypted" for them, so get them from the dashboard's Container Registry page or the developer.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "application": {
      "type": "string",
      "description": "Application name, as returned by edgegap_list_apps."
    }
  },
  "required": [
    "application"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "application": {
      "type": "string"
    },
    "total": {
      "type": "number"
    },
    "showing": {
      "type": "number"
    },
    "truncated": {
      "type": "boolean"
    },
    "next_step": {
      "type": "string"
    },
    "versions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "active": {
            "type": "boolean"
          },
          "image": {
            "type": "string"
          },
          "registry_credentials_set": {
            "type": "boolean"
          },
          "cpu_units": {
            "type": "number"
          },
          "memory_mb": {
            "type": "number"
          },
          "max_duration_minutes": {
            "type": "number"
          },
          "ports": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "port": {
                  "type": "number"
                },
                "protocol": {
                  "type": "string"
                },
                "tls_upgrade": {
                  "type": "boolean"
                }
              },
              "additionalProperties": {}
            }
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢edgegap_get_app_version(application, version)

Read one version in full: image, resources, ports, max_duration, whether image caching (force_cache) and verify_image are on, restart policy, and the names of its env vars (values are never shown). Use it before edgegap_update_app_version or edgegap_deploy to check what a version will do.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "application": {
      "type": "string",
      "description": "Application name."
    },
    "version": {
      "type": "string",
      "description": "Version name, as listed by edgegap_list_app_versions."
    }
  },
  "required": [
    "application",
    "version"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "application": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "active": {
      "type": "boolean"
    },
    "image": {
      "type": "string"
    },
    "registry_credentials_set": {
      "type": "boolean"
    },
    "cpu_units": {
      "type": "number"
    },
    "memory_mb": {
      "type": "number"
    },
    "max_duration_minutes": {
      "type": "number"
    },
    "ports": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "port": {
            "type": "number"
          },
          "protocol": {
            "type": "string"
          },
          "tls_upgrade": {
            "type": "boolean"
          }
        },
        "additionalProperties": {}
      }
    },
    "force_cache": {
      "type": "boolean"
    },
    "caching_percent": {
      "type": "number"
    },
    "verify_image": {
      "type": "boolean"
    },
    "restart_policy": {
      "type": "string"
    },
    "termination_grace_period_seconds": {
      "type": "number"
    },
    "env": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "hidden": {
            "type": "boolean"
          }
        },
        "additionalProperties": {}
      }
    },
    "auto_stop_after_minutes": {
      "type": "number"
    },
    "auto_stop": {
      "type": "string"
    },
    "warning": {
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟡edgegap_create_app_version(application, name, docker_repository, docker_image, docker_tag, ...)

Register a container image as a deployable version of an application. The image must already be pushed to a registry that Edgegap can pull from (see edgegap_get_registry_credentials and edgegap_list_registry_tags). Resource units: 1024 cpu units = 1 vCPU; memory_mb must be at least 256 and at most double the cpu units. Set verify_image true on the first version so a bad image fails here rather than at deploy time. Refused, with nothing sent, for the "latest" or an empty docker tag (use a build ID so deployments are reproducible) and for a docker_image that also holds a registry host or tag. Env vars named like secrets (TOKEN, SECRET, PASSWORD, API_KEY…) are hidden in the dashboard. When copying an existing version, copy only non-secret settings: the API returns "This value is set and encrypted" for its registry login and secret env values, and that placeholder is refused here.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "application": {
      "type": "string",
      "description": "Existing application name."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Version identifier, typically a build ID or timestamp."
    },
    "docker_repository": {
      "type": "string",
      "description": "Registry host, e.g. \"docker.io\" or \"registry.edgegap.com\"."
    },
    "docker_image": {
      "type": "string",
      "description": "Namespaced image, e.g. \"mystudio/game-server\"."
    },
    "docker_tag": {
      "type": "string",
      "description": "Image tag: a build ID, commit SHA or timestamp. \"latest\" and empty tags are refused."
    },
    "cpu_units": {
      "type": "integer",
      "minimum": 256,
      "maximum": 9007199254740991,
      "description": "vCPU units. 1024 = 1 vCPU."
    },
    "memory_mb": {
      "type": "integer",
      "minimum": 256,
      "maximum": 9007199254740991,
      "description": "Memory in MB. At most 2x cpu_units."
    },
    "ports": {
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "port": {
            "type": "integer",
            "minimum": 1,
            "maximum": 59999,
            "description": "Port the server listens on."
          },
          "protocol": {
            "type": "string",
            "description": "One of UDP, TCP, TCP/UDP, HTTP, HTTPS, WS, WSS. Most game servers use UDP."
          },
          "name": {
            "description": "Label, e.g. \"gameport\".",
            "type": "string"
          },
          "to_check": {
            "description": "Readiness check on this port. Default true.",
            "type": "boolean"
          },
          "tls_upgrade": {
            "description": "Edgegap terminates TLS on this port, so clients connect with wss:// or https://. Required for browser (WebGL) clients, which cannot use plain ws:// from an https page. WS and HTTP ports only. Default false.",
            "type": "boolean"
          }
        },
        "required": [
          "port",
          "protocol"
        ]
      },
      "description": "Ports to expose. At least one is required for players to connect."
    },
    "registry_username": {
      "description": "Registry username. Needed for private images, including images in your own registry.edgegap.com project: Edgegap pulls with this login, not your API token.",
      "type": "string"
    },
    "registry_token": {
      "description": "Registry password or token.",
      "type": "string"
    },
    "max_duration_minutes": {
      "description": "Auto-stop after this many minutes. Keeps test deployments from running up cost.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "verify_image": {
      "description": "Verify Edgegap can pull the image before accepting the version.",
      "type": "boolean"
    },
    "env": {
      "description": "Environment variables injected into the container. Values are never echoed back.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "value"
        ]
      }
    },
    "dry_run": {
      "description": "Show the exact request (method, host, path, body) with secrets masked, and send nothing. Local checks still run. Use it to confirm a billable or destructive call before making it.",
      "type": "boolean"
    }
  },
  "required": [
    "application",
    "name",
    "docker_repository",
    "docker_image",
    "docker_tag",
    "cpu_units",
    "memory_mb",
    "ports"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟡edgegap_update_app_version(application, version, is_active, docker_repository, docker_image, ...)

Change settings on an existing version instead of creating a new one: point it at a new image tag, turn it on or off, change max_duration, set the registry login, turn on image caching (force_cache: Edgegap pre-loads the image so deployments start faster), or set the shutdown grace period. Only the fields you pass change. Deployments already running keep their old settings; new deployments get the new ones. Same refusals as edgegap_create_app_version: "latest" or empty tags, a docker_image holding a host or tag, and the API token in the registry login or env vars. ports and env REPLACE the version's whole list (per the API): read the current ones with edgegap_get_app_version and pass every port or variable to keep; secret env values are not readable, so get them from the developer. Refused, with nothing sent, for a registry login or env value equal to the API's "This value is set and encrypted" placeholder; leave the registry login out to keep it. CPU and memory cannot be changed here; create a new version, or override them per deployment in edgegap_deploy.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "application": {
      "type": "string",
      "description": "Application name."
    },
    "version": {
      "type": "string",
      "description": "Version name to change."
    },
    "is_active": {
      "description": "false blocks new deployments of this version.",
      "type": "boolean"
    },
    "docker_repository": {
      "description": "Registry host, e.g. \"registry.edgegap.com\".",
      "type": "string"
    },
    "docker_image": {
      "description": "Image path, e.g. \"my-org-abc123/my-game-server\".",
      "type": "string"
    },
    "docker_tag": {
      "description": "New image tag: a build ID, commit SHA or timestamp.",
      "type": "string"
    },
    "registry_username": {
      "type": "string"
    },
    "registry_token": {
      "description": "Registry password or token. Never echoed back.",
      "type": "string"
    },
    "max_duration_minutes": {
      "description": "Auto-stop after this many minutes. Capped by EDGEGAP_MAX_DURATION_MINUTES.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "force_cache": {
      "description": "Pre-load the image on Edgegap so deployments start faster.",
      "type": "boolean"
    },
    "verify_image": {
      "description": "Check Edgegap can pull the image when saving.",
      "type": "boolean"
    },
    "termination_grace_period_seconds": {
      "description": "Seconds between SIGTERM and SIGKILL when a deployment stops.",
      "type": "integer",
      "minimum": 0,
      "maximum": 3600
    },
    "ports": {
      "description": "REPLACES every port on the version. Include the ports to keep, not only new ones.",
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "port": {
            "type": "integer",
            "minimum": 1,
            "maximum": 59999,
            "description": "Port the server listens on."
          },
          "protocol": {
            "type": "string",
            "description": "One of UDP, TCP, TCP/UDP, HTTP, HTTPS, WS, WSS. Most game servers use UDP."
          },
          "name": {
            "description": "Label, e.g. \"gameport\".",
            "type": "string"
          },
          "to_check": {
            "description": "Readiness check on this port. Default true.",
            "type": "boolean"
          },
          "tls_upgrade": {
            "description": "wss:// / https:// for browser clients. WS and HTTP ports only.",
            "type": "boolean"
          }
        },
        "required": [
          "port",
          "protocol"
        ]
      }
    },
    "env": {
      "description": "REPLACES every env var on the version; [] removes them all. Values are never echoed back.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "value"
        ]
      }
    },
    "dry_run": {
      "description": "Show the exact request (method, host, path, body) with secrets masked, and send nothing. Local checks still run. Use it to confirm a billable or destructive call before making it.",
      "type": "boolean"
    }
  },
  "required": [
    "application",
    "version"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢edgegap_list_locations(application, version, page, limit)

List the cities Edgegap can deploy to. Pass application and version to see only the locations with capacity for that version right now. Use it to pick geo_coordinates for edgegap_deploy when you have no player IPs, or to tell a developer where their players can be served from. For the ping beacons game clients use to measure latency, see edgegap_list_ping_beacons.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "application": {
      "description": "With version: only locations with capacity for it now.",
      "type": "string"
    },
    "version": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "limit": {
      "description": "Default 100.",
      "type": "integer",
      "minimum": 1,
      "maximum": 200
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "filtered_for": {
      "type": "string"
    },
    "total": {
      "type": "number"
    },
    "showing": {
      "type": "number"
    },
    "truncated": {
      "type": "boolean"
    },
    "next_step": {
      "type": "string"
    },
    "locations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "city": {
            "type": "string"
          },
          "region": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "continent": {
            "type": "string"
          },
          "latitude": {
            "type": "number"
          },
          "longitude": {
            "type": "number"
          }
        },
        "additionalProperties": {}
      }
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢edgegap_list_ping_beacons(page, limit)

List Edgegap's ping beacons: one host per region that a game client can ping (UDP or TCP) to measure its latency before matchmaking. The matchmaker's latency rules use these measurements. Read-only; the game client does the pinging, not this tool.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "limit": {
      "description": "Default 100.",
      "type": "integer",
      "minimum": 1,
      "maximum": 200
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "total": {
      "type": "number"
    },
    "beacons": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "host": {
            "type": "string"
          },
          "udp_port": {
            "type": "number"
          },
          "tcp_port": {
            "type": "number"
          },
          "city": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "continent": {
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟡edgegap_deploy(application, version, users, env, tags, ...)

Start one authoritative dedicated game server from an application version, placed near the players you specify. This is the recommended way to host a multiplayer match: the server owns the game state, so no player hosts it. Returns immediately with a request_id; the server is still starting and has no connection details yet. Follow this call with edgegap_wait_for_deployment to get the address players connect to. Always stop deployments you started for testing. Every deployment is tagged "edgegap-mcp" in addition to any tags you pass, so edgegap_list_deployments with only_agent_deployments: true finds them all. Runs until stopped or until the version's max_duration, which the result reports. Refused, with nothing sent, if the API token appears in an env var or tag, if the version uses the "latest" docker tag, or when too many agent deployments are already running (EDGEGAP_MAX_AGENT_DEPLOYMENTS, default 5): stop finished ones first. Env vars named like secrets are hidden in the dashboard.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "application": {
      "type": "string",
      "description": "Application name."
    },
    "version": {
      "type": "string",
      "description": "Version name within the application."
    },
    "users": {
      "type": "object",
      "properties": {
        "ip_addresses": {
          "description": "Public IPv4/IPv6 addresses of the players. Edgegap places the server near them.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "geo_coordinates": {
          "description": "Latitude/longitude pairs, as an alternative to IP addresses.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "latitude": {
                "type": "number"
              },
              "longitude": {
                "type": "number"
              }
            },
            "required": [
              "latitude",
              "longitude"
            ]
          }
        }
      },
      "description": "Where the players are. Exactly one of these two is required."
    },
    "env": {
      "description": "Environment variables for this deployment only. Values are never echoed back.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "value"
        ]
      }
    },
    "tags": {
      "description": "Extra tags for filtering later, e.g. [\"agent-test\"]. \"edgegap-mcp\" is always added.",
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 40
      }
    },
    "cpu_units": {
      "description": "Override the version's CPU for this deployment only, with memory_mb. 1024 = 1 vCPU.",
      "type": "integer",
      "minimum": 256,
      "maximum": 9007199254740991
    },
    "memory_mb": {
      "description": "Override the version's memory for this deployment only, with cpu_units. At most 2x cpu_units.",
      "type": "integer",
      "minimum": 256,
      "maximum": 9007199254740991
    },
    "dry_run": {
      "description": "Show the exact request (method, host, path, body) with secrets masked, and send nothing. Local checks still run. Use it to confirm a billable or destructive call before making it.",
      "type": "boolean"
    }
  },
  "required": [
    "application",
    "version",
    "users"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "auto_stop_after_minutes": {
      "type": "number"
    },
    "auto_stop": {
      "type": "string"
    },
    "warning": {
      "type": "string"
    },
    "resources": {
      "type": "object",
      "properties": {
        "cpu_units": {
          "type": "number"
        },
        "memory_mib": {
          "type": "number"
        }
      },
      "additionalProperties": {}
    },
    "next_step": {
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢edgegap_get_deployment(request_id)

Read the current status of one deployment, including connection address and ports once it is ready. For a deployment you just created, prefer edgegap_wait_for_deployment — it polls for you instead of making you call this in a loop.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "description": "The request_id returned by edgegap_deploy."
    }
  },
  "required": [
    "request_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "running": {
      "type": "boolean"
    },
    "ready": {
      "type": "boolean"
    },
    "error": {
      "type": "boolean"
    },
    "error_detail": {
      "type": "string"
    },
    "fqdn": {
      "type": "string"
    },
    "public_ip": {
      "type": "string"
    },
    "application": {
      "type": "string"
    },
    "version": {
      "type": "string"
    },
    "location": {
      "type": "string"
    },
    "elapsed_seconds": {
      "type": "number"
    },
    "ports": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "connect": {
            "type": "string"
          },
          "external": {
            "type": "number"
          },
          "internal": {
            "type": "number"
          },
          "protocol": {
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    },
    "next_step": {
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢edgegap_wait_for_deployment(request_id, timeout_seconds)

Poll a deployment until it is ready, errors, or the timeout expires, then return the connection details. This is the tool to call right after edgegap_deploy. Do not build your own polling loop — this handles backoff and reports the container error detail if the server fails to start.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "description": "The request_id returned by edgegap_deploy."
    },
    "timeout_seconds": {
      "description": "How long to wait before giving up, 5-600. Default 180.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "request_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "running": {
      "type": "boolean"
    },
    "ready": {
      "type": "boolean"
    },
    "error": {
      "type": "boolean"
    },
    "error_detail": {
      "type": "string"
    },
    "fqdn": {
      "type": "string"
    },
    "public_ip": {
      "type": "string"
    },
    "application": {
      "type": "string"
    },
    "version": {
      "type": "string"
    },
    "location": {
      "type": "string"
    },
    "elapsed_seconds": {
      "type": "number"
    },
    "ports": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "connect": {
            "type": "string"
          },
          "external": {
            "type": "number"
          },
          "internal": {
            "type": "number"
          },
          "protocol": {
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    },
    "next_step": {
      "type": "string"
    },
    "waited_seconds": {
      "type": "number"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢edgegap_list_deployments(only_agent_deployments, filters, order_by, limit)

List active deployments, optionally filtered and sorted. Use this to find deployments left running from earlier sessions before starting new ones — orphaned servers cost money. Filter by status, application, version, tags, request_id, created_at, fleet_name or host_name, e.g. [{field:"application",operator:"eq",value:"my-game"},{field:"status",operator:"eq",value:"ready"}]. Operators: eq and neq on every field except created_at (eq, gte, lte); in and nin with an array value on request_id, tags, application, version, fleet_name, host_name; ilike with % wildcards on fleet_name and host_name. At most one filter per field. Sort by created_at or available_session_sockets. To find every deployment an agent started through this server, pass only_agent_deployments: true (the same as filtering tags in ["edgegap-mcp", "mcp"]).

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "only_agent_deployments": {
      "description": "Only deployments started through this server: tagged \"edgegap-mcp\", or \"mcp\" by versions up to 0.3.3. Cannot be combined with a tags filter.",
      "type": "boolean"
    },
    "filters": {
      "description": "Omit for all deployments.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "enum": [
              "status",
              "request_id",
              "tags",
              "created_at",
              "application",
              "version",
              "fleet_name",
              "host_name"
            ]
          },
          "operator": {
            "type": "string",
            "enum": [
              "eq",
              "neq",
              "in",
              "nin",
              "gte",
              "lte",
              "ilike"
            ]
          },
          "value": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ],
            "description": "A string, or an array of strings for in/nin. created_at is ISO 8601, e.g. \"2026-09-30T00:00:00Z\"."
          }
        },
        "required": [
          "field",
          "operator",
          "value"
        ]
      }
    },
    "order_by": {
      "description": "e.g. [{field:\"created_at\",order:\"asc\"}] for oldest first.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "enum": [
              "created_at",
              "available_session_sockets"
            ]
          },
          "order": {
            "type": "string",
            "enum": [
              "asc",
              "desc"
            ]
          }
        },
        "required": [
          "field",
          "order"
        ]
      }
    },
    "limit": {
      "description": "1-100. Default 50.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "total": {
      "type": "number"
    },
    "showing": {
      "type": "number"
    },
    "truncated": {
      "type": "boolean"
    },
    "next_step": {
      "type": "string"
    },
    "deployments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "request_id": {
            "type": "string"
          },
          "ready": {
            "type": "boolean"
          },
          "fqdn": {
            "type": "string"
          },
          "started": {
            "type": "string"
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🔴edgegap_stop_deployment(request_id, dry_run)

Gracefully stop one deployment by request_id, sending SIGTERM to the container. Stop every deployment you started for testing before ending your task. This tool stops exactly one deployment, named by its exact request_id: empty IDs, wildcards and lists are refused, and bulk stop is deliberately not exposed.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "description": "The exact request_id of the one deployment to stop, e.g. \"61b1be8f54d9\"."
    },
    "dry_run": {
      "description": "Show the exact request (method, host, path, body) with secrets masked, and send nothing. Local checks still run. Use it to confirm a billable or destructive call before making it.",
      "type": "boolean"
    }
  },
  "required": [
    "request_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢edgegap_get_deployment_logs(request_id, max_characters)

Retrieve stdout/stderr and crash output for a deployment. Call this whenever a deployment errors or a server exits unexpectedly — the crash exit code usually identifies the problem faster than redeploying does. Logs for stopped deployments are only retained if Endpoint Storage was configured on the version beforehand.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "description": "The request_id of the deployment."
    },
    "max_characters": {
      "description": "Truncate logs to this length (500-50000), keeping the tail. Default 8000.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "request_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢edgegap_get_deployment_metrics(request_id, start_time, end_time, step)

Summarise a deployment's resource use over time: CPU, CPU throttling, memory and network, each as latest, average and peak, with the API's own labels. Use it to size a version (cpu_units, memory_mb) from a real match, or to check whether a crash was memory or CPU starvation before redeploying. Defaults to the whole life of the deployment.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "description": "The request_id of the deployment."
    },
    "start_time": {
      "description": "ISO 8601. Default: when the deployment started.",
      "type": "string"
    },
    "end_time": {
      "description": "ISO 8601. Default: now, or when it stopped.",
      "type": "string"
    },
    "step": {
      "description": "Averaging step, e.g. \"30s\" or \"5m\". Default: the API's.",
      "type": "string"
    }
  },
  "required": [
    "request_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string"
    },
    "cpu": {
      "type": "object",
      "properties": {
        "latest": {
          "type": "number"
        },
        "average": {
          "type": "number"
        },
        "peak": {
          "type": "number"
        },
        "samples": {
          "type": "number"
        },
        "labels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "from": {
          "type": "string"
        },
        "to": {
          "type": "string"
        }
      },
      "additionalProperties": {}
    },
    "cpu_throttle_rate": {
      "type": "object",
      "properties": {
        "latest": {
          "type": "number"
        },
        "average": {
          "type": "number"
        },
        "peak": {
          "type": "number"
        },
        "samples": {
          "type": "number"
        },
        "labels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "from": {
          "type": "string"
        },
        "to": {
          "type": "string"
        }
      },
      "additionalProperties": {}
    },
    "memory": {
      "type": "object",
      "properties": {
        "latest": {
          "type": "number"
        },
        "average": {
          "type": "number"
        },
        "peak": {
          "type": "number"
        },
        "samples": {
          "type": "number"
        },
        "labels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "from": {
          "type": "string"
        },
        "to": {
          "type": "string"
        }
      },
      "additionalProperties": {}
    },
    "network_receive": {
      "type": "object",
      "properties": {
        "latest": {
          "type": "number"
        },
        "average": {
          "type": "number"
        },
        "peak": {
          "type": "number"
        },
        "samples": {
          "type": "number"
        },
        "labels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "from": {
          "type": "string"
        },
        "to": {
          "type": "string"
        }
      },
      "additionalProperties": {}
    },
    "network_transmit": {
      "type": "object",
      "properties": {
        "latest": {
          "type": "number"
        },
        "average": {
          "type": "number"
        },
        "peak": {
          "type": "number"
        },
        "samples": {
          "type": "number"
        },
        "labels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "from": {
          "type": "string"
        },
        "to": {
          "type": "string"
        }
      },
      "additionalProperties": {}
    },
    "totals": {
      "type": "object",
      "properties": {
        "received": {
          "type": "number"
        },
        "transmitted": {
          "type": "number"
        },
        "disk_read": {
          "type": "number"
        },
        "disk_written": {
          "type": "number"
        }
      },
      "additionalProperties": {}
    },
    "note": {
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢edgegap_generate_dockerfile(engine, build_path, executable, ports, netcode, ...)

Write a Dockerfile for this project's headless game server build, ready for Edgegap: linux/amd64 base, the build folder copied in, the binary made executable, the right headless flags (Unity -batchmode -nographics, Godot --headless), a non-root user where the engine needs it (Unreal refuses root), CRLF fixes for start scripts, and EXPOSE lines matching the ports. Call this when the project has no Dockerfile, before building anything. Look at the build output first so you can pass the real build folder, binary name and port; anything you omit is assumed and listed under assumptions, which you must confirm with the developer or the project files. Write the result to Dockerfile, then build. The output is checked against edgegap_validate_server_config before it is returned. Makes no API calls.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "engine": {
      "type": "string",
      "enum": [
        "unity",
        "unreal",
        "godot",
        "other"
      ],
      "description": "Game engine of the server build."
    },
    "build_path": {
      "description": "Server build folder, relative to where docker build runs. Defaults: unity \"Builds/EdgegapServer\", unreal \".\" (run from inside the packaged LinuxServer folder), godot \"build\".",
      "type": "string"
    },
    "executable": {
      "description": "File name of the server binary or start script inside build_path. Defaults: unity \"ServerBuild\", unreal \"StartServer.sh\", godot \"server.x86_64\". Required for \"other\".",
      "type": "string"
    },
    "ports": {
      "description": "Ports the server listens on. Default: 7777, with the protocol the netcode uses (UDP if unknown).",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "port": {
            "type": "integer",
            "minimum": 1,
            "maximum": 59999
          },
          "protocol": {
            "type": "string",
            "enum": [
              "UDP",
              "TCP",
              "TCP/UDP",
              "HTTP",
              "HTTPS",
              "WS",
              "WSS"
            ]
          },
          "name": {
            "type": "string"
          },
          "tls_upgrade": {
            "description": "TLS Upgrade (wss/https) on a WS or HTTP port, for browser clients.",
            "type": "boolean"
          }
        },
        "required": [
          "port",
          "protocol"
        ]
      }
    },
    "netcode": {
      "description": "Networking transport, to pick the protocol. Known: mirror-kcp, kcp, mirror-telepathy, telepathy, mirror-simpleweb, simpleweb, websocket, fishnet-tugboat, tugboat, netcode-for-gameobjects, ngo, unity-transport, utp, photon-fusion, litenetlib, enet, unreal-netdriver, godot-enet, godot-websocket.",
      "type": "string"
    },
    "launch_args": {
      "description": "Extra server arguments, one per entry, e.g. [\"-log\", \"-port=7777\"].",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "base_image": {
      "description": "Default \"ubuntu:22.04\".",
      "type": "string"
    }
  },
  "required": [
    "engine"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢edgegap_validate_server_config(dockerfile, engine, netcode, ports, cpu_units, ...)

Check a game server Dockerfile and the ports/resources you intend to register against what Edgegap requires, BEFORE building and pushing. Catches the failures that otherwise only show up after a build, push, version and deploy: ARM or Windows images (Edgegap runs linux/amd64), Unreal running as root, missing Unity -batchmode -nographics, a server bound to localhost, EXPOSE ports that do not match the version ports, a protocol that does not match the netcode transport, the "latest" tag, and bad CPU/memory ratios. Pass the Dockerfile text (read it from disk first). If there is no Dockerfile yet, call edgegap_generate_dockerfile instead. Makes no API calls.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "dockerfile": {
      "description": "Full text of the Dockerfile.",
      "type": "string"
    },
    "engine": {
      "description": "Game engine. Detected from the Dockerfile when omitted.",
      "type": "string",
      "enum": [
        "unity",
        "unreal",
        "godot",
        "other"
      ]
    },
    "netcode": {
      "description": "Networking transport, to check the port protocol. Known: mirror-kcp, kcp, mirror-telepathy, telepathy, mirror-simpleweb, simpleweb, websocket, fishnet-tugboat, tugboat, netcode-for-gameobjects, ngo, unity-transport, utp, photon-fusion, litenetlib, enet, unreal-netdriver, godot-enet, godot-websocket.",
      "type": "string"
    },
    "ports": {
      "description": "Ports you plan to pass to edgegap_create_app_version.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "port": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "protocol": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "tls_upgrade": {
            "description": "TLS Upgrade (wss/https) on a WS or HTTP port, for browser clients.",
            "type": "boolean"
          }
        },
        "required": [
          "port",
          "protocol"
        ]
      }
    },
    "cpu_units": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "memory_mb": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "docker_repository": {
      "type": "string"
    },
    "docker_image": {
      "type": "string"
    },
    "docker_tag": {
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "verdict": {
      "type": "string"
    },
    "engine": {
      "type": "string"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "severity": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "fix": {
            "type": "string"
          },
          "line": {
            "type": "number"
          }
        },
        "additionalProperties": {}
      }
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "severity": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "fix": {
            "type": "string"
          },
          "line": {
            "type": "number"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟡edgegap_get_registry_credentials(image_name, tag)

Get the push login for this organization's private Edgegap container registry (registry.edgegap.com) and the exact docker login, build and push commands for your image. Use this when the server image is not in a registry yet. Edgegap only hands these credentials to the quick-start token the Unity/Unreal plugins use; with a regular API token this tool cannot fetch them and instead returns the steps to copy them from the dashboard's Container Registry page — ask the developer for them then, do not retry. When it does return a token, it is registry-scoped (push/pull images in this project), not the org API token: pass it to docker login via --password-stdin, never as a command-line argument, and do not write it into files. Call edgegap_validate_server_config before building. Any other registry Edgegap can pull from (Docker Hub, GHCR, ECR, GitLab) works too: then skip this tool and pass that registry and its pull login to edgegap_create_app_version.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "image_name": {
      "description": "Image name without project or tag, e.g. \"my-game-server\". Used to build the commands.",
      "type": "string",
      "pattern": "^[a-z0-9]+([._-][a-z0-9]+)*$"
    },
    "tag": {
      "description": "Unique build tag for the commands, e.g. a build ID. Never \"latest\".",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢edgegap_list_registry_tags(image_name, page, limit)

List the tags pushed for one image in this organization's Edgegap container registry, with push time and size. Call it after docker push to confirm the tag landed before edgegap_create_app_version, which otherwise fails later with an image-pull error. An image that was never pushed comes back as status "not_found" with no tags, not as an error. Only for registry.edgegap.com: images in Docker Hub, GHCR or another registry are not listed here.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "image_name": {
      "type": "string",
      "minLength": 1,
      "description": "The image name only, without the project, registry host or tag, e.g. \"my-game-server\". The API reads the project from your token; \"<project>/my-game-server\" is not found."
    },
    "page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "limit": {
      "description": "1-100. Default 20.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "image_name"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "image_name": {
      "type": "string"
    },
    "note": {
      "type": "string"
    },
    "total": {
      "type": "number"
    },
    "showing": {
      "type": "number"
    },
    "truncated": {
      "type": "boolean"
    },
    "next_step": {
      "type": "string"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "tag": {
            "type": "string"
          },
          "pushed": {
            "type": "string"
          },
          "size_mb": {
            "type": "number"
          },
          "digest": {
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🔴edgegap_delete_registry_tag(image_name, tag, dry_run)

Delete one tag, and the image it points to, from this organization's Edgegap container registry, to clean up old builds. Takes exactly one image name and one exact tag; wildcards, lists and "latest" are refused, and there is no bulk delete. A version that still uses the tag can no longer start deployments, so check edgegap_list_app_versions first. Cannot be undone.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "image_name": {
      "type": "string",
      "minLength": 1,
      "description": "The image name only, e.g. \"my-game-server\", as for edgegap_list_registry_tags."
    },
    "tag": {
      "type": "string",
      "description": "The exact tag to delete, e.g. \"build-41\"."
    },
    "dry_run": {
      "description": "Show the exact request (method, host, path, body) with secrets masked, and send nothing. Local checks still run. Use it to confirm a billable or destructive call before making it.",
      "type": "boolean"
    }
  },
  "required": [
    "image_name",
    "tag"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴edgegap_create_relay_session(user_ips, webhook_url, wait_until_ready, timeout_seconds, dry_run)

A relay is NOT a game server and is not the recommended default — for a multiplayer match, deploy an authoritative dedicated server with edgegap_deploy instead. A relay only forwards traffic between players while one player's game acts as host and owns the game state: the host can cheat and has a latency advantage, the host's PC and connection cap the match, and the match ends if the host quits. Only use this when the developer has chosen peer-to-peer/host-client, or the netcode is already a listen server and a dedicated server is not an option; if that has not been established, ask first. Never pick it only because it needs no server image. Creates an Edgegap relay session for every player's public IP, host first, waits until it is ready, and returns the relay address plus per-player authorization tokens for the relay transport. Relay sessions are billed while open: delete test sessions with edgegap_delete_relay_session when finished.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "user_ips": {
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 3
      },
      "description": "Public IP of each player, host first. Add late joiners with edgegap_authorize_relay_user."
    },
    "webhook_url": {
      "description": "Called when the session is ready.",
      "type": "string",
      "format": "uri"
    },
    "wait_until_ready": {
      "description": "Poll until the relay is assigned. Default true.",
      "type": "boolean"
    },
    "timeout_seconds": {
      "description": "Default 30.",
      "type": "integer",
      "minimum": 5,
      "maximum": 120
    },
    "dry_run": {
      "description": "Show the exact request (method, host, path, body) with secrets masked, and send nothing. Local checks still run. Use it to confirm a billable or destructive call before making it.",
      "type": "boolean"
    }
  },
  "required": [
    "user_ips"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢edgegap_get_relay_session(session_id)

Read one relay session: whether it is ready, the relay address and ports, and each authorized player with their authorization token. edgegap_create_relay_session already waits for readiness; use this to re-read a session or one created with wait_until_ready false.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "session_id": {
      "type": "string",
      "description": "Returned by edgegap_create_relay_session."
    }
  },
  "required": [
    "session_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢edgegap_list_relay_sessions

List this organization's active relay sessions: id, status, readiness and player count. Relay sessions bill while open, so use this to find ones left over from earlier sessions and delete them with edgegap_delete_relay_session. Authorization tokens are not listed; read one session with edgegap_get_relay_session.

Eingabe-Schema

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Ausgabe-Schema

{
  "type": "object",
  "properties": {
    "total": {
      "type": "number"
    },
    "showing": {
      "type": "number"
    },
    "truncated": {
      "type": "boolean"
    },
    "next_step": {
      "type": "string"
    },
    "sessions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "session_id": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "ready": {
            "type": "boolean"
          },
          "linked": {
            "type": "boolean"
          },
          "players": {
            "type": "number"
          },
          "relay": {
            "type": "string"
          },
          "error": {
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
⚪edgegap_authorize_relay_user(session_id, user_ip, dry_run)

Authorize one more player (by public IP) on an existing relay session, for a player joining after the session was created. Returns that player's authorization token.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "session_id": {
      "type": "string"
    },
    "user_ip": {
      "type": "string",
      "minLength": 3,
      "description": "Public IP of the joining player."
    },
    "dry_run": {
      "description": "Show the exact request (method, host, path, body) with secrets masked, and send nothing. Local checks still run. Use it to confirm a billable or destructive call before making it.",
      "type": "boolean"
    }
  },
  "required": [
    "session_id",
    "user_ip"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴edgegap_revoke_relay_user(session_id, user_authorization_token, dry_run)

Revoke one player's access to a relay session, by that player's authorization token (from edgegap_get_relay_session or edgegap_authorize_relay_user). The player loses the relay connection; the session and the other players stay.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "session_id": {
      "type": "string",
      "description": "The relay session_id, e.g. \"0724828881e2-S\"."
    },
    "user_authorization_token": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "The player's authorization token, not the session's."
    },
    "dry_run": {
      "description": "Show the exact request (method, host, path, body) with secrets masked, and send nothing. Local checks still run. Use it to confirm a billable or destructive call before making it.",
      "type": "boolean"
    }
  },
  "required": [
    "session_id",
    "user_authorization_token"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴edgegap_delete_relay_session(session_id, dry_run)

Close one relay session. Connected players lose their relay connection. Delete every session you created for testing before ending your task. Takes exactly one session_id; empty IDs, wildcards and lists are refused.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "session_id": {
      "type": "string",
      "description": "The exact session_id of the one session to delete, e.g. \"0724828881e2-S\"."
    },
    "dry_run": {
      "description": "Show the exact request (method, host, path, body) with secrets masked, and send nothing. Local checks still run. Use it to confirm a billable or destructive call before making it.",
      "type": "boolean"
    }
  },
  "required": [
    "session_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢edgegap_build_matchmaker_config(profile_name, application, version, team_count, min_team_size, ...)

Generate a ready-to-upload Edgegap matchmaker JSON configuration with one profile: team count and size, optional latency rule, and optional expansions that relax the rules the longer a player waits. Checks the referenced application version exists and has ports. Edgegap has no API for creating a matchmaker, so this tool does NOT create one: save the returned config to a file (e.g. matchmaker-config.json) and have the developer upload it on the Matchmaker page of the dashboard. The matchmaker starts an authoritative dedicated server for each match, which is the recommended setup for multiplayer games.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "profile_name": {
      "type": "string",
      "description": "Profile clients will queue into, e.g. \"casual-2v2\"."
    },
    "application": {
      "type": "string",
      "description": "Application the matchmaker deploys."
    },
    "version": {
      "type": "string",
      "description": "Version the matchmaker deploys."
    },
    "team_count": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991,
      "description": "Teams per match. 1 for free-for-all or co-op."
    },
    "min_team_size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "max_team_size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "max_latency_ms": {
      "description": "Adds a latency rule: drop players above this ping to the chosen region. Needs beacon pings from the client.",
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "latency_difference_ms": {
      "description": "Max ping spread between matched players. Default 100.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "expansions": {
      "description": "Rule relaxations after a player has waited this long, e.g. [{after_seconds: 20, min_team_size: 1}]. Keep each below ticket_expiration. Not needed for partial matches: min_team_size below max_team_size already allows them. Expansions cost the matchmaker performance, so add one only to relax a rule.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "after_seconds": {
            "type": "integer",
            "minimum": 1,
            "maximum": 9007199254740991
          },
          "min_team_size": {
            "type": "integer",
            "minimum": 1,
            "maximum": 9007199254740991
          },
          "max_latency_ms": {
            "type": "integer",
            "minimum": 1,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "after_seconds"
        ]
      }
    },
    "ticket_expiration": {
      "description": "Default \"30s\", so a developer testing alone is matched or told to retry within 30 s instead of waiting minutes. Raise it only for production queues.",
      "type": "string"
    },
    "inspect": {
      "description": "Expose the inspection API for debugging. Default true; turn off for production.",
      "type": "boolean"
    },
    "verify_version": {
      "description": "Look up the application version first. Default true.",
      "type": "boolean"
    },
    "allowed_cors_origins": {
      "description": "Origins of web pages allowed to call the matchmaker, e.g. [\"https://mygame.example.com\", \"http://localhost:8080\"]. Required when game clients run in a browser (WebGL): browsers block matchmaker calls from any origin not listed. Scheme and host only, no path.",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "profile_name",
    "application",
    "version",
    "team_count",
    "min_team_size",
    "max_team_size"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢edgegap_list_skills

List the Edgegap agent skills: tested, step-by-step workflows for getting a multiplayer game online on Edgegap, with templates (Dockerfiles, matchmaker configs, Unity C# and Unreal C++ drop-ins) and known pitfalls. Each entry says which engine, netcode or backend it is for, and the server instructions map projects to skills. Before working on a game project, load the matching skill with edgegap_get_skill; "edgegap" covers any other engine and routes to the rest. Also says whether a newer skills pack is on GitHub (reads one version number, no Edgegap API call).

Eingabe-Schema

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢edgegap_get_skill(skill, file)

Load one Edgegap agent skill: its SKILL.md (the workflow to follow) by default, or one of its reference documents or templates with file. Load the skill that matches the project before acting (the server instructions and edgegap_list_skills say which; "edgegap" when unsure), then fetch the references and templates it points to as you reach them. No API call.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "skill": {
      "type": "string",
      "description": "Skill name, from edgegap_list_skills: edgegap, edgegap-colyseus, edgegap-containerize, edgegap-deployments-api, edgegap-eos-voice, edgegap-fishnet, edgegap-fusion, edgegap-fusion-simplefps, edgegap-godot, edgegap-launch, edgegap-local-testing, edgegap-manus, edgegap-matchmaking, edgegap-nakama, edgegap-ngo, edgegap-playfab, edgegap-purrnet, edgegap-server-design, edgegap-threejs, edgegap-troubleshoot, edgegap-unity, edgegap-unreal."
    },
    "file": {
      "description": "A file inside the skill, e.g. \"references/deploy.md\" or \"assets/docker/Dockerfile\". Default SKILL.md.",
      "type": "string"
    }
  },
  "required": [
    "skill"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢edgegap_update_skills(installed_versions)

Check whether the Edgegap agent skills installed in the developer's agent are the latest, and update them. This hosted server cannot see the developer's disk: pass installed_versions (each loaded skill's metadata.version from its SKILL.md frontmatter) and it compares them with the latest on GitHub and says how to update. Skill text is never downloaded by this tool. The skills served by edgegap_get_skill need no update here.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "installed_versions": {
      "description": "Skill name → version of skills you have loaded from somewhere this server cannot see, e.g. {\"edgegap-unity\": \"0.1.8\"}. The version is metadata.version in the SKILL.md frontmatter.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Community

Diesen Server bewerten

Nachweis

Aktuelle Beobachtungen

verifiziertVersion nicht aufgezeichnet32 Tools
verifiziertVersion nicht aufgezeichnet22 Tools
verifiziertVersion nicht aufgezeichnet19 Tools
verifiziertVersion nicht aufgezeichnet19 Tools
verifiziertVersion nicht aufgezeichnet10 Tools
verifiziertVersion nicht aufgezeichnet10 Tools