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
Merged
Conversation
…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.
This was referenced Aug 3, 2026
ankitk-me
approved these changes
Aug 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
mcp-openapireference page'soptions.toolssection only documented thedescription/summary/input/outputoverrides — it never mentioned thex-zilla-mcpOpenAPI vendor extension (title/description/annotations) thatmcp-kafka-connectandmcp-schema-registryalready use, via anoverlay, to supply real MCP tool metadata for their bundled specs without an authoredoptions.toolsentry or editing the vendored OpenAPI document.options.tools.titleoroptions.tools.annotations, even though both are real, existing config fields alongsidedescription/summary/input/output.tools.titleandtools.annotations(with its four hint childrenreadOnlyHint/destructiveHint/idempotentHint/openWorldHint) property docs.tools.description's precedence text to include thex-zilla-mcp.descriptionfallback layer that sits between the authored override and the operation's nativedescription/id.specs.overlay, since overlay is the mechanism used to inject it) documenting thex-zilla-mcpoperation extension's shape and precedence, cross-linking tomcp-kafka-connect/mcp-schema-registryas 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 referencingmcp-openapi(the tracked.check-schema/zilla-schema.jsononly defines the basemcpbinding type, predatingmcp-openapi/mcp-http/mcp-kafkaentirely — same pre-existing gap noted in docs(mcp): add mcp-kafka-connect and mcp-schema-registry binding reference #417, not introduced by this change)binding-mcp-openapisource on zilla'sdevelopbranch (McpOpenapiCompositeGenerator.toolTitle/toolDescription/toolAnnotations,McpEx)pnpm dev(not run in this environment)Generated by Claude Code