Repository navigation
fix: enhance wiki search tool to include repository path and pagePath… #1700
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Dan Hellem (danhellem)
wants to merge
1
commit into
main
Choose a base branch
from
users/danhellem/wiki-search-fix-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+142
−3
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -81,7 +81,7 @@ function configureSearchTools(server: McpServer, tokenProvider: () => Promise<st | |
|
|
||
| server.tool( | ||
| SEARCH_TOOLS.search_wiki, | ||
| "Search Azure DevOps Wiki for a given search text", | ||
| "Search Azure DevOps Wiki for a given search text. Results include the repository path and a wiki-relative pagePath that can be used with the wiki tool.", | ||
| { | ||
| searchText: z.string().describe("Keywords to search for wiki pages"), | ||
| project: z.array(z.string()).optional().describe("Filter by projects"), | ||
|
|
@@ -123,8 +123,11 @@ function configureSearchTools(server: McpServer, tokenProvider: () => Promise<st | |
| throw new Error(`Azure DevOps Wiki Search API error: ${response.status} ${response.statusText}`); | ||
| } | ||
|
|
||
| const result = await response.text(); | ||
| return createExternalContentResponse(result, "wiki search results"); | ||
| const result = (await response.json()) as WikiSearchResponse; | ||
| const results = result.results?.map(addWikiPagePath); | ||
| const enrichedResult = results ? { ...result, results } : result; | ||
|
|
||
| return createExternalContentResponse(JSON.stringify(enrichedResult), "wiki search results"); | ||
| } | ||
| ); | ||
|
|
||
|
|
@@ -192,8 +195,39 @@ interface SearchResult { | |
| [key: string]: unknown; | ||
| } | ||
|
|
||
| interface WikiSearchResult { | ||
| path?: string; | ||
| pagePath?: string; | ||
| wiki?: { | ||
| mappedPath?: string; | ||
| [key: string]: unknown; | ||
| }; | ||
| [key: string]: unknown; | ||
| } | ||
|
|
||
| interface WikiSearchResponse { | ||
| results?: WikiSearchResult[]; | ||
| [key: string]: unknown; | ||
| } | ||
|
|
||
| type CombinedResult = { gitItem: GitItem } | { error: string }; | ||
|
|
||
| function addWikiPagePath(result: WikiSearchResult): WikiSearchResult { | ||
| if (result.pagePath || !result.path || !result.wiki?.mappedPath) { | ||
| return result; | ||
| } | ||
|
|
||
| const mappedPath = result.wiki.mappedPath === "/" ? "" : result.wiki.mappedPath.replace(/\/+$/, ""); | ||
| if (mappedPath && result.path !== mappedPath && !result.path.startsWith(`${mappedPath}/`)) { | ||
| return result; | ||
| } | ||
|
|
||
| const relativePath = decodeURIComponent(result.path.slice(mappedPath.length).replace(/\.md$/i, "")); | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. decodeURIComponent can throw URIError when result.path contains malformed encoding |
||
| const pagePath = relativePath.startsWith("/") ? relativePath : `/${relativePath}`; | ||
|
|
||
| return { ...result, pagePath }; | ||
| } | ||
|
|
||
| async function fetchCombinedResults(topSearchResults: SearchResult[], gitApi: IGitApi): Promise<CombinedResult[]> { | ||
| const combinedResults: CombinedResult[] = []; | ||
| for (const searchResult of topSearchResults) { | ||
|
|
||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we have null check for result
if (!result || result.pagePath || !result.path || !result.wiki?.mappedPath) {
return result;
}