This topic provides important guidance and highlights common pitfalls when configuring the OpenEdge MCP Server. Following these recommendations ensures reliable operation and prevents misconfigurations that can lead to failures or security gaps.

The following list summarizes common pitfalls and their recommended remedies:
  • Forgetting to set base_url causes relative downstream URLs to fail. Always configure either api.openapi.base_url or runtime.http.base_url.
  • Enabling authentication without defining scopes makes discovery work but renders access control meaningless. Define a default scope early in the configuration.
  • Disabling the response guard during early development is acceptable, but re-enable it before load testing or LLM integration to prevent runaway payloads.
  • Avoid large prompt directories. The aggregate size guard prevents excessive memory usage and ensures predictable performance.
Note: For detailed instructions on generating profiles and certificates, see Use the mcpgen CLI for profile generation and management.