Skip to content

docs: derive example call values from schema example/default/enum#9

Merged
andig merged 1 commit into
mainfrom
fix/doc-example-values
Jul 1, 2026
Merged

docs: derive example call values from schema example/default/enum#9
andig merged 1 commit into
mainfrom
fix/doc-example-values

Conversation

@andig

@andig andig commented Jul 1, 2026

Copy link
Copy Markdown
Member

The Markdown doc generator (cmd/openapi-mcp/doc.go) built example-call values from the parameter type alone, emitting "example"/true placeholders even when a param defined example, enum or default.

exampleValue now prefers, in order: exampledefault → first enum value → the type-based placeholder. Params without any of those keep the previous placeholder behaviour. The runtime tool schema is unchanged — only generated docs are affected.

Verified against evcc server/openapi.yaml, getEnergyHistory:

call getEnergyHistory {
  "aggregate": "15m",     // was "example"  (default)
  "format": "json",       // was "example"  (enum/default)
  "grouped": false,       // was true       (default)
  "from": "example",      // unchanged: no example/default/enum
  "lang": "example",
  "to": "example"
}

Adds doc_test.go covering the precedence.

Fixes evcc-io/evcc#31377

🤖 Generated with Claude Code

The Markdown doc generator built example-call values from the parameter
type alone, emitting "example"/true placeholders even when a param
defined example, default or enum. Prefer those before falling back to
the type placeholder. Runtime tool schema is unaffected.

Fixes evcc-io/evcc#31377

@naltatis naltatis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@andig andig merged commit 26c4421 into main Jul 1, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MCP docs: example calls ignore schema example/default/enum

2 participants