Repository navigation
[Automated] Draft docs (agentgateway): feat(mcp): make the ui:// URI target delimiter configurable - #1455
Open
github-actions[bot] wants to merge 7 commits into
Open
[Automated] Draft docs (agentgateway): feat(mcp): make the ui:// URI target delimiter configurable#1455github-actions[bot] wants to merge 7 commits into
github-actions[bot] wants to merge 7 commits into
Conversation
…target delimiter configurable Drafts-Commit: 6a128f1 Signed-off-by: GitHub Action <action@github.com>
Deploying agentproxy with
|
| Latest commit: |
021b36f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://69ba83fa.agentproxy.pages.dev |
| Branch Preview URL: | https://pr-tracker-draft-agentgatewa-0u35.agentproxy.pages.dev |
The release-notes entry for this change now lives in the combined release-notes PR, #1482, so the draft PRs no longer conflict on the release-notes pages. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Collaborator
|
Moved this PR's release-notes entry to the combined release-notes PR, #1482, so the draft PRs stop conflicting on the release-notes pages. Review or change the entry there. |
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Kristin Brown <kristin.brown@solo.io>
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.
agentgateway/agentgateway#4200 — feat(mcp): make the ui:// URI target delimiter configurable
Docs versions:
standalone/main,kubernetes/mainWhat changes for users: Operators can set
AGENTGATEWAY_MCP_UI_URI_DELIMITERwhen an MCP host rejects the default+separator in multiplexedui://resource URIs. Valid replacement delimiters are_,-,., and~; invalid values log a warning and keep the default+.What the docs now say: The shared MCP Apps page now explains the delimiter environment variable, the default behavior, the allowed replacement values, and the requirement to choose a delimiter that does not appear in target names.
Not verified: No cluster; the configuration is unrun, and internal links are unchecked.
How
agentgateway-4200was drafted, and what was not verifiedPlan, and what changed it
AGENTGATEWAY_MCP_UI_URI_DELIMITERbehavior to the MCP Apps documentation for both affected modes.Why a documentation change is necessary
The pull request makes the delimiter in multiplexed
ui://{target}+{rest}resource URIs configurable withAGENTGATEWAY_MCP_UI_URI_DELIMITER. The MCP Apps page already documents how agentgateway rewrites UI resource URIs during multiplexing, but it did not tell readers how to handle hosts such as GitHub Copilot that reject the default+delimiter.What changed on disk
assets/agw-docs/pages/agentgateway/mcp/apps.md: Adds main-only documentation forAGENTGATEWAY_MCP_UI_URI_DELIMITER, including valid values, fallback behavior, and target-name guidance.How to verify this change
AGENTGATEWAY_MCP_UI_URI_DELIMITER=_set before the proxy starts.ui://<target>_<rest>. If the delimiter value is empty, more than one character, or not one of the allowed symbols, the proxy logs a warning and uses+.What was not verified
How the pages were chosen (triage report)
New configuration: no page mentions it yet
agentgateway/agentgateway#4200 — feat(mcp): make the ui:// URI target delimiter configurable
agentgateway/website+inencode_ui_uriconfigurable - The default is still a+so its backward compatibleRelease notes
This pull request also adds its release-note entries:
content/docs/kubernetes/main/release-notes/release-notes.md: MCP Apps UI URI delimiter is configurable (feature, in a new 1.8 section)content/docs/standalone/main/release-notes/release-notes.md: MCP Apps UI URI delimiter is configurable (feature, in a new 1.8 section)Check these release-note links and names. Each note is on its page, but a link may not reach the drafted content there, or a name may belong to the other mode:
content/docs/standalone/main/release-notes/release-notes.md: feat(mcp): make the ui:// URI target delimiter configurable agentgateway#4200's note namesAGENTGATEWAY_MCP_UI_URI_DELIMITER, whichcontent/docs/kubernetes/mainmentions andcontent/docs/standalone/maindoes not. Check that this tree's readers can set it, or word the note for this mode.content/docs/standalone/main/release-notes/release-notes.md: feat(mcp): make the ui:// URI target delimiter configurable agentgateway#4200's note namesbetween the target name and UI resource path when an MCP host rejects the default, whichcontent/docs/kubernetes/mainmentions andcontent/docs/standalone/maindoes not. Check that this tree's readers can set it, or word the note for this mode.Draft branch:
pr-tracker-draft-agentgateway-4200