Management OverviewΒΆ
This section provides operational guidance for running and maintaining a production instance of MCP Gateway.
Whether you're self-hosting, running in the cloud, or deploying to Kubernetes, this section helps you monitor, back up, and maintain the system.
What's new in 0.7.0 (preview)
The upcoming v0.7.0 introduces multiβtenancy: email authentication, teams, RBAC, and resource visibility (private/team/public).
- See the Migration Guide and Changelog
- Quick enablement (excerpt):
EMAIL_AUTH_ENABLED=true
,PLATFORM_ADMIN_EMAIL=...
,AUTO_CREATE_PERSONAL_TEAMS=true
- Learn more: Team Management, RBAC
π§ What's CoveredΒΆ
Page | Description |
---|---|
Configuration | Complete configuration reference - databases, environment variables, and deployment settings |
Dynamic Client Registration | π OAuth2 DCR - Automatic client provisioning for streamable HTTP servers |
Backups | How to persist and restore your database, configs, and resource state |
Export & Import | Complete configuration management with CLI, API, and Admin UI |
Export/Import Tutorial | Step-by-step tutorial for getting started with export/import |
Export/Import Reference | Quick reference guide for export/import commands and APIs |
Bulk Import | Import multiple tools at once for migrations and team onboarding |
Metadata Tracking | π NEW - Comprehensive audit trails and entity metadata tracking |
Well-Known URIs | Configure robots.txt, security.txt, and custom well-known files |
Logging | Configure structured logging, log destinations, and log rotation |
π Runtime Config via .env
ΒΆ
Most operational settings (logging level, database pool size, auth mode) are controlled through .env
or environment variables.
MariaDB & MySQL Fully Supported
MCP Gateway now has complete MariaDB/MySQL support alongside SQLite and PostgreSQL:
- 36+ database tables work perfectly with MariaDB 12.0+ and MySQL 8.4+
- All VARCHAR length issues resolved for MariaDB/MySQL compatibility
- Connection string:
DATABASE_URL=mysql+pymysql://mysql:changeme@localhost:3306/mcp
- See Configuration Reference for complete setup instructions
Update the file and restart the container or process to apply changes.
π§ͺ Health & ReadinessΒΆ
Expose the /health
endpoint for use with:
- Cloud load balancer health checks
- Kubernetes probes
- CI/CD smoke tests
Sample check:
Expected response:
π Service Restart CommandsΒΆ
Depending on your environment:
docker restart mcpgateway
kubectl rollout restart deployment/mcpgateway