Skip to content
This repository was archived by the owner on Aug 3, 2026. It is now read-only.

docs(mcp-openapi): document x-zilla-mcp extension and tools.title/annotations - #419

Merged
ankitk-me merged 1 commit into
support/2.xfrom
claude/mcp-bindings-reference-docs-awhemg
Aug 3, 2026
Merged

docs(mcp-openapi): document x-zilla-mcp extension and tools.title/annotations#419
ankitk-me merged 1 commit into
support/2.xfrom
claude/mcp-bindings-reference-docs-awhemg

Conversation

@jfallows

@jfallows jfallows commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • The mcp-openapi reference page's options.tools section only documented the description/summary/input/output overrides — it never mentioned the x-zilla-mcp OpenAPI vendor extension (title/description/annotations) that mcp-kafka-connect and mcp-schema-registry already use, via an overlay, to supply real MCP tool metadata for their bundled specs without an authored options.tools entry or editing the vendored OpenAPI document.
  • It also never documented options.tools.title or options.tools.annotations, even though both are real, existing config fields alongside description/summary/input/output.
  • Adds:
    • tools.title and tools.annotations (with its four hint children readOnlyHint/destructiveHint/idempotentHint/openWorldHint) property docs.
    • Corrects tools.description's precedence text to include the x-zilla-mcp.description fallback layer that sits between the authored override and the operation's native description/id.
    • An info callout (placed after specs.overlay, since overlay is the mechanism used to inject it) documenting the x-zilla-mcp operation extension's shape and precedence, cross-linking to mcp-kafka-connect/mcp-schema-registry as the in-tree usage example.

Test plan

  • pnpm lint — no new violations introduced (verified the changed file specifically has zero reported issues; all other reported issues are pre-existing, in unrelated files)
  • pnpm check-schema — no output referencing mcp-openapi (the tracked .check-schema/zilla-schema.json only defines the base mcp binding type, predating mcp-openapi/mcp-http/mcp-kafka entirely — same pre-existing gap noted in docs(mcp): add mcp-kafka-connect and mcp-schema-registry binding reference #417, not introduced by this change)
  • Verified the documented precedence chains directly against the current binding-mcp-openapi source on zilla's develop branch (McpOpenapiCompositeGenerator.toolTitle/toolDescription/toolAnnotations, McpEx)
  • Visual check of the rendered page via pnpm dev (not run in this environment)

Generated by Claude Code

…otations

The options.tools reference only documented description/summary/input/output
overrides, and never mentioned the x-zilla-mcp OpenAPI vendor extension
(title/description/annotations) that mcp-kafka-connect and mcp-schema-registry
use via overlay to supply MCP metadata without an authored options.tools entry
or editing the vendored spec. Adds tools.title and tools.annotations (with its
four hint children), corrects the tools.description precedence chain, and adds
an info callout documenting the x-zilla-mcp extension shape and fallback order.

@jfallows jfallows left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

LGTM

@ankitk-me
ankitk-me merged commit ed263e4 into support/2.x Aug 3, 2026
0 of 3 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants