Before performing an upgrade, use the following checklist to ensure readiness:
Item Description
Retain exported bundle Verify that the exported bundle for the current version is retained in the exports/<name>-<oldver> directory.
Review OpenAPI specification changes Confirm that the OpenAPI specification differences are reviewed. Ensure that operationIds remain stable and any changes are intentional.
Validate configuration changes Validate changes in mcp_server_config.json in the staging environment. Confirm that response guard and rate limiting settings are still appropriate.
Run diagnostic checks Ensure that the new version passes the ./mcpgen doctor command successfully.
Document new configuration keys Verify that any new configuration keys are documented and that their default values are acceptable.

Upgrade procedure from development to production

Follow these steps to upgrade the OpenEdge MCP Server from development to production:
  1. Pull the new Git tag or image digests.
  2. Regenerate the profile in development by using the same specification and prompts to regenerate the profile:
    ./mcpgen up --no-prompt --tls --spec ./openapi.yml
  3. Perform smoke tests and run representative tool invocations.
  4. Export the production-ready bundle using the following command:
    ./mcpgen export prof --bundle prod
  5. Diff the exported mcp_server_config.json against the previous version. Confirm that only intended changes are present.
  6. Deploy the new bundle alongside the old bundle on a different port. Validate functionality in staging.
  7. Perform production cutover by scaling down the old compose after the health check passes on the new deployment.
  8. Monitor logs for errors, rate limit issues, and response guard events for 15 to 30 minutes.
  9. If a regression occurs, stop the new bundle and restart the previous bundle without changes.