[Automated] Draft docs (agentgateway): fix(mcp): harden OpenAPI path parameter handling - #1129
Open
github-actions[bot] wants to merge 1 commit into
Open
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…parameter handling Signed-off-by: GitHub Action <action@github.com>
Deploying agentproxy with
|
| Latest commit: |
7633855
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7a08635e.agentproxy.pages.dev |
| Branch Preview URL: | https://pr-tracker-draft-agentgatewa-t939.agentproxy.pages.dev |
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Draft a documentation change
agentgateway/agentgateway#3598 — fix(mcp): harden OpenAPI path parameter handling
agentgateway/websiteagentgateway/agentgateway#3598 - fix(mcp): harden OpenAPI path parameter handling
agentgateway/agentgateway#3598 hardens OpenAPI path parameter handling for MCP tools generated from an OpenAPI schema. Readers configuring OpenAPI MCP servers now know that path parameters are required, that values must be strings or numbers, and that string values are percent-encoded before forwarding. The behavior changes existing invalid inputs: missing values, unsupported value types, empty segments, and
.or..path segments now fail before any upstream HTTP request is sent. Before this change, an invalid value could leave a literal template placeholder in the path or forward a traversal-like value.How
agentgateway-3598was drafted, and what was not verifiedagentgateway/agentgateway#3598 - fix(mcp): harden OpenAPI path parameter handling
Plan, and what changed it
content/docs/kubernetes/main/integrations/mcp/servers.mdis a redirect, the Kubernetes MCP candidates are section indexes or generic MCP pages, and no Kubernetes OpenAPI server guide exists in the target set.Path parameterssection tocontent/docs/standalone/main/integrations/mcp/servers/openapi.md; wrote no Kubernetes prose because the available pages do not own OpenAPI server behavior.Why a documentation change is necessary
The pull request changes how OpenAPI MCP tools handle path parameters. The existing standalone OpenAPI page shows an inline OpenAPI schema with a path parameter, but it did not explain that path parameters are forced into the required tool schema or which values are rejected before forwarding. A reader using generated tools against an OpenAPI backend would not know why missing, boolean, empty, or dot-segment path values now fail locally instead of reaching the upstream API.
What changed on disk
content/docs/standalone/main/integrations/mcp/servers/openapi.md- Added the required path-parameter behavior, accepted value types, percent-encoding behavior, and invalid-request cases.How to verify this change
Follow the standalone OpenAPI server guide to start the Petstore server and run
agentgateway -f config.yaml.Open a session against the local MCP endpoint and call the generated
getPetByIdtool with an unsafe path parameter value.The response shows an invalid request error for the
petIdpath parameter, and the Petstore container logs do not show a request for../admin,%2Fadmin, or a literal{petId}path.Proposed release note
The proposed note does not link to the docs page because the item resolved to both standalone/main and kubernetes/main, but only the standalone tree has an OpenAPI MCP server page.
What was not verified
The configuration was not applied to a cluster, so every command in this diff is unrun. The workflow-provided
cluster-facts.mdfile was used only as API surface; no Kubernetes resources were applied. The standalone OpenAPI guide was not run locally in this CI sandbox.A declared version this draft does not reach
This pull request is planned for more than one documentation version,
and nothing in the diff publishes to:
kubernetes/mainA file under
assets/reaches a version tree only where a page in thattree reuses it, so editing a shared asset does not by itself cover every
mode a product ships. Either that version still needs writing, or the
change genuinely does not apply there and the reason belongs in this body.
Draft branch:
pr-tracker-draft-agentgateway-3598Important
The test suite has not run on this pull request. It was opened by
github-actions[bot], and GitHub does not start workflows for pull requests opened with the repository's own token. Doc tests, link checking and the static checks are held asaction_requireduntil somebody presses Approve and run on the Checks tab. Cloudflare Pages and DCO are GitHub Apps rather than Actions, so those two do run on their own.Please approve the checks before reviewing the content: an absence of failures here means the tests have not run, not that they passed.