Platform Requirements

Two ongoing requirements to keep your MCP server live. Learn what they are, why they matter, and how to fix issues if they occur.

Need help? Connect help.mctx.ai for instant answers.

Your server requires two active prerequisites to remain live. These aren't just one-time setup steps — they're ongoing requirements. If either lapses, your server is automatically suspended until you restore the missing prerequisite.

The Two Prerequisites

1. GitHub OAuth Connection

What it is: Your GitHub account must be connected to mctx. This allows mctx to access your repository and deploy your server's code.

Why it's required: Without GitHub access, mctx can't pull your code, deploy updates, or verify repository access.

How to fix: Reconnect your GitHub account at app.mctx.ai/dev/settings. Click Connect GitHub and authorize the GitHub OAuth app.

2. GitHub App Installation

What it is: The mctx GitHub App must be installed on your GitHub account or organization with access to your MCP server's repository.

Why it's required: The GitHub App provides repository-level permissions for deployment automation, webhook delivery, and registry publishing.

How to fix: Reinstall the GitHub App at app.mctx.ai/dev/settings. Click Install GitHub App and grant access to your repository.

Optional Settings That Affect Functionality

Payout Setup

What it is: Optional payout account setup required only if you enable monetization on your MCP server.

Not required to deploy — your server goes live without payout setup. Hosting fees (above the free tier) use a separate billing flow via a standard payment method, not a payout account.

When required: If you choose to charge subscribers for your server (optional monetization), you must complete payout setup before enabling monetization. This allows mctx to route subscriber payments to your bank account.

How to set up: Go to app.mctx.ai/dev/payouts when you're ready to enable monetization.

What Happens When Prerequisites Lapse

Automatic Suspension

If either GitHub prerequisite fails, mctx automatically suspends all your live servers:

Subscribers see "temporarily unavailable" instead of your server
You receive an in-app notification and email explaining the issue

Suspension is Immediate

Detection happens via multiple channels:

Webhooks (GitHub) — Real-time detection within seconds
API validation (before every deployment) — Deployment gating prevents issues

Hosting Fee Suspension

If your server exceeds the free tier (1,000 requests/month) without a payment method on file, your server is suspended immediately with reason hosting_payment_required.

All requests above 1,000/month are billed at graduated rates — including in the month the threshold is first crossed. There is no billing waiver for the first overage month.
The dashboard shows a persistent banner with an Add Payment Method button when your server is suspended for this reason
Suspension is lifted immediately when you add a valid payment method

Removing your payment method: If you remove your hosting payment method, every server you own that has previously crossed the free-tier threshold is suspended immediately — not at the next request or billing cycle. One payment method covers all your servers.

See How Pricing Works for the full fee schedule and suspension mechanics.

How Reactivation Works

Reactivation behavior depends on why your server was suspended:

Automatic Restoration (External Issues)

When: A temporary platform issue is resolved — for example, a GitHub App installation is re-verified.

What happens:

Your server automatically returns to live status
Subscribers can use your server immediately
No action required from you

Deploy to Restore (Deliberate Actions)

When: You disconnect a prerequisite (uninstall GitHub App, revoke OAuth).

What happens:

Your server automatically returns to ready status
You must click Deploy to make it live again
Subscribers can't use your server until you deploy

Why the extra step: mctx treats deliberate disconnections as a signal you intended to take your server offline. The deploy requirement ensures you're ready to bring it back live.

Example: You uninstalled the mctx GitHub App (perhaps to clean up unused apps), then reinstalled it. Your server moves to ready status — click Deploy to restore it.

Missing Prerequisite Blocks Deploy

If you try to deploy while any prerequisite is missing, the deploy button is disabled with a message explaining which prerequisites are missing. Fix all issues first, then deploy.

Monitoring Your Server Status

Dashboard Indicators

Server list page (app.mctx.ai/dev/servers):

Green "Live" badge — All prerequisites met, server is accessible
Yellow "Ready" badge — Prerequisites met, but not deployed yet
Red "Suspended" badge — One or more prerequisites missing
Yellow "Setup Required" badge — Initial setup not completed (usually GitHub connection)

Server detail page (app.mctx.ai/dev/servers):

Status banner at top shows suspension reason if applicable
Quick-fix links take you directly to the relevant settings page

Notifications

You'll receive notifications when:

Server is suspended (lists affected servers and reason)
Server is reactivated (lists restored servers and new status)
Deployment blocked due to missing prerequisites

Notification delivery:

In-app (red badge on notifications bell)
Email (if email notifications enabled in app.mctx.ai/usr/settings)

Prevention Best Practices

Don't disconnect GitHub integrations casually. If you need to remove access temporarily:

Expect your servers to be suspended immediately
Subscribers will see "temporarily unavailable" messages
Plan for downtime until you restore prerequisites

Test changes in test environment first. Use app-test.mctx.ai to validate changes before affecting production servers.

Common Scenarios

"I uninstalled the GitHub App by mistake"

Status: All your servers are now suspended with reason "GitHub App uninstalled"

Fix:

Go to app.mctx.ai/dev/settings
Click Install GitHub App
Grant access to your repository
Your servers return to ready status
Deploy each server to restore to live

"My server was suspended for hosting fees"

Status: Server suspended with reason "Hosting payment required"

Fix:

Go to app.mctx.ai/dev/servers
Click the Add Payment Method button in the banner
Enter a valid payment method
Your server is restored immediately

Troubleshooting

Dashboard shows "Live" but subscribers report errors

Cause: Status may not be synced between database and edge network.

Fix: Click Deploy Server to force a status sync. If issue persists, contact support.

Deploy button enabled but deployment fails

Cause: Prerequisite validation passed, but deployment encountered a different error (build failure, health check timeout, etc.).

Fix: Check deployment logs on your server detail page. Common issues:

Repository deleted or made private
Build script failed (missing dependencies, syntax errors)
Health check timeout (server didn't respond within 30 seconds)

Received suspension notification but don't know which prerequisite failed

Check: Go to your server detail page (app.mctx.ai/dev/servers). The status banner shows the specific suspension reason.

Common reasons:

"GitHub App uninstalled" → Reinstall at developer settings
"GitHub OAuth disconnected" → Reconnect at developer settings
"Hosting payment required" → Add payment method from server detail banner

Next Steps

Prerequisites are designed to be set-once, maintained-automatically. Keep your GitHub integrations connected and you won't encounter suspension issues.

Related guides:

Connect GitHub — GitHub OAuth and App installation
How Pricing Works — Free tier, hosting fees, and billing mechanics

See something wrong? Report it or suggest an improvement — your feedback helps make these docs better.

Platform Requirements

On this page