For the complete documentation index, see llms.txt. This page is also available as Markdown.

MCP Integration

MCP servers expose a convenient troubleshooting toolkit for your custom coding AI agents.

👉 Supported Features

Use our MCP server when:

  • Containerizing your game server - your agent writes a Dockerfile for your build (or checks the one you have) against Edgegap's requirements, then pushes the image to your private Edgegap container registry.

  • Deploying a dedicated server - create an application and version, deploy close to your players, and get the connection details.

  • Building a CI/CD pipeline - test your deployments and teardown from a build system.

  • Troubleshooting a game server issue with your own coding agent: inspecting app versions and deployment status, reading container logs, or reproducing a failed deployment.

  • Running a host-client game - create a relay session if your game is built with one player as host. See Dedicated Servers or Relays? first.

If you need help, please reach out to us over Discord. For live games support see our ticketing system.

Example prompts

  • "Write a Dockerfile for my three.js server build, then push it and deploy a server near me."

  • "Check my Dockerfile for Edgegap and fix any problems."

  • "My deployment failed. Read the logs and tell me why."

  • "My game uses host-client networking. Set up an Edgegap relay for two players."

🚀 Installation

MCP server installation is very simple:

  1. Install the MCP server for Popular Agents or with Custom Integration.

  2. Generate and attach an API token for your agent to use with our MCP server:

Generate (and view) your secret tokens for Edgegap API in Dashboard - User Settings / Tokens.

Add your secret token with each API request as an HTTP header (include the word token):

Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Install Edgegap MCP server in your preferred agentic IDE: CursorVS Code

Claude Code

ChatGPT Codex

mcp.json

Most agentic IDEs also support integration by pasting JSON configuration:

Custom Integration

The official repository is the single source of truth for custom integration of our MCP server:

Install remote Edgegap MCP server in your agent's virtualized environment (never in your project!):

🚨 Troubleshooting

Review common error codes and learn how to unlock your integration.

401 Unauthorized

Your MCP integration is most likely not including the Authorization header correctly.

403 Forbidden

Your MCP integration is likely using the template token or a deleted token. Please validate that the token value used by your integration matches exactly the token displayed in dashboard.

424 Image Could Not Be Pulled

Edgegap could not pull your container image. Check the repository, image name, and tag, and if the tag was pushed (ask your agent to list registry tags). For images in the Edgegap registry, the image name must include your project, e.g. my-project/my-game-server.

Registry Credentials Unavailable

If your agent can't retrieve registry credentials, request them in the dashboard under Container Registry, or push to another registry Edgegap can pull from (Docker Hub, GitHub, AWS ECR, GCP, GitLab). See External Registries.

Server Starts Locally but Not on Edgegap

Ask your agent to validate your server configuration, or to generate a new Dockerfile. The most common causes are an image built on Apple Silicon without docker build --platform linux/amd64, a server listening on a different port than the version exposes, or a UDP transport configured as TCP.

Other API Errors

Please consult our API Reference for possible error responses for individual API endpoints.

If you need help, please reach out to us over Discord. For live games support see our ticketing system.

Last updated

Was this helpful?