Preserve KB UTM source in results#93
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Arm MCP knowledge base search tool to ensure utm_source=arm-mcp (and URL fragments) are preserved when agents share URLs returned from knowledge_base_search.
Changes:
- Expanded the
knowledge_base_searchtool description to explicitly instruct preserving returned URLs exactly (including query params/fragments). - Added a per-result
url_tracking_instructionfield to KB search results alongside the tracked URL. - Introduced a reusable preservation note constant in the response formatting layer.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| mcp-local/server.py | Adds explicit tool-level guidance to preserve returned URLs (including utm_source=arm-mcp and fragments). |
| arm_kb_search/response.py | Adds a per-result preservation instruction and attaches it when adding utm_source to results. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
JoeStech
approved these changes
Jun 18, 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 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.
Problem:
knowledge_base_search returns with utm_source=arm-mcp, but the agent like codex truncates it in the results as it thinks it is not needed. We would like the users to get URLs with utm_source=arm-mcp.
Solution:
Ensure agents preserve
utm_source=arm-mcpwhen sharing URLs returned byknowledge_base_search.This adds explicit guidance in the tool description and includes a per-result instruction alongside tracked URLs so query parameters and fragments are not removed or rewritten.