When parameter_examples is set to true, the enrichment process inspects existing path and query parameters, including parameters defined at both the path level and the operation level, resolving any local $ref references. For each parameter that does not already have an example, the system applies the following rules:
  • Derive example values using heuristics
    • For integer parameters, the example value is 1.
    • For string parameters with a format:date, the example value is 2024-01-01.
    • Other types follow similar simple heuristics.

  • Skip sensitive parameter names

    Parameters that contain authentication-related substrings such as auth, token, secret, or password are excluded from example generation.

  • Do not overwrite existing examples

    The system does not replace any example fields that already exist at the parameter level or schema level.

Purpose of parameter examples

Manage per-tool context for API operationsManage per-tool context for API operationsThe purpose of parameter examples is to provide helpful hints in the user interface. These examples are intended to improve usability and clarity without imposing any business-specific semantics.