@azure-devops/mcp 1.2.0-daily.20250715 → 1.2.1

package/dist/tools/repos.js

@@ -3,6 +3,7 @@
 import { PullRequestStatus, GitVersionType, GitPullRequestQueryType, } from "azure-devops-node-api/interfaces/GitInterfaces.js";
 import { z } from "zod";
 import { getCurrentUserDetails } from "./auth.js";
+import { getEnumKeys } from "../utils.js";
 const REPO_TOOLS = {
     list_repos_by_project: "repo_list_repos_by_project",
     list_pull_requests_by_repo: "repo_list_pull_requests_by_repo",
@@ -18,6 +19,7 @@ const REPO_TOOLS = {
     update_pull_request_status: "repo_update_pull_request_status",
     update_pull_request_reviewers: "repo_update_pull_request_reviewers",
     reply_to_comment: "repo_reply_to_comment",
+    create_pull_request_thread: "repo_create_pull_request_thread",
     resolve_comment: "repo_resolve_comment",
     search_commits: "repo_search_commits",
     list_pull_requests_by_commits: "repo_list_pull_requests_by_commits",
@@ -30,17 +32,37 @@ function branchesFilterOutIrrelevantProperties(branches, top) {
         .sort((a, b) => b.localeCompare(a))
         .slice(0, top);
 }
+/**
+ * Trims comment data to essential properties, filtering out deleted comments
+ * @param comments Array of comments to trim (can be undefined/null)
+ * @returns Array of trimmed comment objects with essential properties only
+ */
+function trimComments(comments) {
+    return comments
+        ?.filter((comment) => !comment.isDeleted) // Exclude deleted comments
+        ?.map((comment) => ({
+        id: comment.id,
+        author: {
+            displayName: comment.author?.displayName,
+            uniqueName: comment.author?.uniqueName,
+        },
+        content: comment.content,
+        publishedDate: comment.publishedDate,
+        lastUpdatedDate: comment.lastUpdatedDate,
+        lastContentUpdatedDate: comment.lastContentUpdatedDate,
+    }));
+}
 function pullRequestStatusStringToInt(status) {
     switch (status) {
-        case "abandoned":
+        case "Abandoned":
             return PullRequestStatus.Abandoned.valueOf();
-        case "active":
+        case "Active":
             return PullRequestStatus.Active.valueOf();
-        case "all":
+        case "All":
             return PullRequestStatus.All.valueOf();
-        case "completed":
+        case "Completed":
             return PullRequestStatus.Completed.valueOf();
-        case "notSet":
+        case "NotSet":
             return PullRequestStatus.NotSet.valueOf();
         default:
             throw new Error(`Unknown pull request status: ${status}`);
@@ -79,11 +101,11 @@ function configureRepoTools(server, tokenProvider, connectionProvider) {
     server.tool(REPO_TOOLS.update_pull_request_status, "Update status of an existing pull request to active or abandoned.", {
         repositoryId: z.string().describe("The ID of the repository where the pull request exists."),
         pullRequestId: z.number().describe("The ID of the pull request to be published."),
-        status: z.enum(["active", "abandoned"]).describe("The new status of the pull request. Can be 'active' or 'abandoned'."),
+        status: z.enum(["Active", "Abandoned"]).describe("The new status of the pull request. Can be 'Active' or 'Abandoned'."),
     }, async ({ repositoryId, pullRequestId, status }) => {
         const connection = await connectionProvider();
         const gitApi = await connection.getGitApi();
-        const statusValue = status === "active" ? 3 : 2;
+        const statusValue = status === "Active" ? PullRequestStatus.Active.valueOf() : PullRequestStatus.Abandoned.valueOf();
         const updatedPullRequest = await gitApi.updatePullRequest({ status: statusValue }, repositoryId, pullRequestId);
         return {
             content: [{ type: "text", text: JSON.stringify(updatedPullRequest, null, 2) }],
@@ -144,7 +166,10 @@ function configureRepoTools(server, tokenProvider, connectionProvider) {
         skip: z.number().default(0).describe("The number of pull requests to skip."),
         created_by_me: z.boolean().default(false).describe("Filter pull requests created by the current user."),
         i_am_reviewer: z.boolean().default(false).describe("Filter pull requests where the current user is a reviewer."),
-        status: z.enum(["abandoned", "active", "all", "completed", "notSet"]).default("active").describe("Filter pull requests by status. Defaults to 'active'."),
+        status: z
+            .enum(getEnumKeys(PullRequestStatus))
+            .default("Active")
+            .describe("Filter pull requests by status. Defaults to 'Active'."),
     }, async ({ repositoryId, top, skip, created_by_me, i_am_reviewer, status }) => {
         const connection = await connectionProvider();
         const gitApi = await connection.getGitApi();
@@ -189,7 +214,10 @@ function configureRepoTools(server, tokenProvider, connectionProvider) {
         skip: z.number().default(0).describe("The number of pull requests to skip."),
         created_by_me: z.boolean().default(false).describe("Filter pull requests created by the current user."),
         i_am_reviewer: z.boolean().default(false).describe("Filter pull requests where the current user is a reviewer."),
-        status: z.enum(["abandoned", "active", "all", "completed", "notSet"]).default("active").describe("Filter pull requests by status. Defaults to 'active'."),
+        status: z
+            .enum(getEnumKeys(PullRequestStatus))
+            .default("Active")
+            .describe("Filter pull requests by status. Defaults to 'Active'."),
     }, async ({ project, top, skip, created_by_me, i_am_reviewer, status }) => {
         const connection = await connectionProvider();
         const gitApi = await connection.getGitApi();
@@ -235,13 +263,27 @@ function configureRepoTools(server, tokenProvider, connectionProvider) {
         baseIteration: z.number().optional().describe("The base iteration ID for which to retrieve threads. Optional, defaults to the latest base iteration."),
         top: z.number().default(100).describe("The maximum number of threads to return."),
         skip: z.number().default(0).describe("The number of threads to skip."),
-    }, async ({ repositoryId, pullRequestId, project, iteration, baseIteration, top, skip }) => {
+        fullResponse: z.boolean().optional().default(false).describe("Return full thread JSON response instead of trimmed data."),
+    }, async ({ repositoryId, pullRequestId, project, iteration, baseIteration, top, skip, fullResponse }) => {
         const connection = await connectionProvider();
         const gitApi = await connection.getGitApi();
         const threads = await gitApi.getThreads(repositoryId, pullRequestId, project, iteration, baseIteration);
         const paginatedThreads = threads?.sort((a, b) => (a.id ?? 0) - (b.id ?? 0)).slice(skip, skip + top);
+        if (fullResponse) {
+            return {
+                content: [{ type: "text", text: JSON.stringify(paginatedThreads, null, 2) }],
+            };
+        }
+        // Return trimmed thread data focusing on essential information
+        const trimmedThreads = paginatedThreads?.map((thread) => ({
+            id: thread.id,
+            publishedDate: thread.publishedDate,
+            lastUpdatedDate: thread.lastUpdatedDate,
+            status: thread.status,
+            comments: trimComments(thread.comments),
+        }));
         return {
-            content: [{ type: "text", text: JSON.stringify(paginatedThreads, null, 2) }],
+            content: [{ type: "text", text: JSON.stringify(trimmedThreads, null, 2) }],
         };
     });
     server.tool(REPO_TOOLS.list_pull_request_thread_comments, "Retrieve a list of comments in a pull request thread.", {
@@ -251,14 +293,22 @@ function configureRepoTools(server, tokenProvider, connectionProvider) {
         project: z.string().optional().describe("Project ID or project name (optional)"),
         top: z.number().default(100).describe("The maximum number of comments to return."),
         skip: z.number().default(0).describe("The number of comments to skip."),
-    }, async ({ repositoryId, pullRequestId, threadId, project, top, skip }) => {
+        fullResponse: z.boolean().optional().default(false).describe("Return full comment JSON response instead of trimmed data."),
+    }, async ({ repositoryId, pullRequestId, threadId, project, top, skip, fullResponse }) => {
         const connection = await connectionProvider();
         const gitApi = await connection.getGitApi();
         // Get thread comments - GitApi uses getComments for retrieving comments from a specific thread
         const comments = await gitApi.getComments(repositoryId, pullRequestId, threadId, project);
         const paginatedComments = comments?.sort((a, b) => (a.id ?? 0) - (b.id ?? 0)).slice(skip, skip + top);
+        if (fullResponse) {
+            return {
+                content: [{ type: "text", text: JSON.stringify(paginatedComments, null, 2) }],
+            };
+        }
+        // Return trimmed comment data focusing on essential information
+        const trimmedComments = trimComments(paginatedComments);
         return {
-            content: [{ type: "text", text: JSON.stringify(paginatedComments, null, 2) }],
+            content: [{ type: "text", text: JSON.stringify(trimmedComments, null, 2) }],
         };
     });
     server.tool(REPO_TOOLS.list_branches_by_repo, "Retrieve a list of branches for a given repository.", {
@@ -339,25 +389,106 @@ function configureRepoTools(server, tokenProvider, connectionProvider) {
         threadId: z.number().describe("The ID of the thread to which the comment will be added."),
         content: z.string().describe("The content of the comment to be added."),
         project: z.string().optional().describe("Project ID or project name (optional)"),
-    }, async ({ repositoryId, pullRequestId, threadId, content, project }) => {
+        fullResponse: z.boolean().optional().default(false).describe("Return full comment JSON response instead of a simple confirmation message."),
+    }, async ({ repositoryId, pullRequestId, threadId, content, project, fullResponse }) => {
         const connection = await connectionProvider();
         const gitApi = await connection.getGitApi();
         const comment = await gitApi.createComment({ content }, repositoryId, pullRequestId, threadId, project);
+        // Check if the comment was successfully created
+        if (!comment) {
+            return {
+                content: [{ type: "text", text: `Error: Failed to add comment to thread ${threadId}. The comment was not created successfully.` }],
+                isError: true,
+            };
+        }
+        if (fullResponse) {
+            return {
+                content: [{ type: "text", text: JSON.stringify(comment, null, 2) }],
+            };
+        }
         return {
-            content: [{ type: "text", text: JSON.stringify(comment, null, 2) }],
+            content: [{ type: "text", text: `Comment successfully added to thread ${threadId}.` }],
+        };
+    });
+    server.tool(REPO_TOOLS.create_pull_request_thread, "Creates a new comment thread on a pull request.", {
+        repositoryId: z.string().describe("The ID of the repository where the pull request is located."),
+        pullRequestId: z.number().describe("The ID of the pull request where the comment thread exists."),
+        content: z.string().describe("The content of the comment to be added."),
+        project: z.string().optional().describe("Project ID or project name (optional)"),
+        filePath: z.string().optional().describe("The path of the file where the comment thread will be created. (optional)"),
+        rightFileStartLine: z.number().optional().describe("Position of first character of the thread's span in right file. The line number of a thread's position. Starts at 1. (optional)"),
+        rightFileStartOffset: z
+            .number()
+            .optional()
+            .describe("Position of first character of the thread's span in right file. The line number of a thread's position. The character offset of a thread's position inside of a line. Starts at 1. Must only be set if rightFileStartLine is also specified. (optional)"),
+        rightFileEndLine: z
+            .number()
+            .optional()
+            .describe("Position of last character of the thread's span in right file. The line number of a thread's position. Starts at 1. Must only be set if rightFileStartLine is also specified. (optional)"),
+        rightFileEndOffset: z
+            .number()
+            .optional()
+            .describe("Position of last character of the thread's span in right file. The character offset of a thread's position inside of a line. Must only be set if rightFileEndLine is also specified. (optional)"),
+    }, async ({ repositoryId, pullRequestId, content, project, filePath, rightFileStartLine, rightFileStartOffset, rightFileEndLine, rightFileEndOffset }) => {
+        const connection = await connectionProvider();
+        const gitApi = await connection.getGitApi();
+        const threadContext = { filePath: filePath };
+        if (rightFileStartLine !== undefined) {
+            if (rightFileStartLine < 1) {
+                throw new Error("rightFileStartLine must be greater than or equal to 1.");
+            }
+            threadContext.rightFileStart = { line: rightFileStartLine };
+            if (rightFileStartOffset !== undefined) {
+                if (rightFileStartOffset < 1) {
+                    throw new Error("rightFileStartOffset must be greater than or equal to 1.");
+                }
+                threadContext.rightFileStart.offset = rightFileStartOffset;
+            }
+        }
+        if (rightFileEndLine !== undefined) {
+            if (rightFileStartLine === undefined) {
+                throw new Error("rightFileEndLine must only be specified if rightFileStartLine is also specified.");
+            }
+            if (rightFileEndLine < 1) {
+                throw new Error("rightFileEndLine must be greater than or equal to 1.");
+            }
+            threadContext.rightFileEnd = { line: rightFileEndLine };
+            if (rightFileEndOffset !== undefined) {
+                if (rightFileEndOffset < 1) {
+                    throw new Error("rightFileEndOffset must be greater than or equal to 1.");
+                }
+                threadContext.rightFileEnd.offset = rightFileEndOffset;
+            }
+        }
+        const thread = await gitApi.createThread({ comments: [{ content: content }], threadContext: threadContext }, repositoryId, pullRequestId, project);
+        return {
+            content: [{ type: "text", text: JSON.stringify(thread, null, 2) }],
         };
     });
     server.tool(REPO_TOOLS.resolve_comment, "Resolves a specific comment thread on a pull request.", {
         repositoryId: z.string().describe("The ID of the repository where the pull request is located."),
         pullRequestId: z.number().describe("The ID of the pull request where the comment thread exists."),
         threadId: z.number().describe("The ID of the thread to be resolved."),
-    }, async ({ repositoryId, pullRequestId, threadId }) => {
+        fullResponse: z.boolean().optional().default(false).describe("Return full thread JSON response instead of a simple confirmation message."),
+    }, async ({ repositoryId, pullRequestId, threadId, fullResponse }) => {
         const connection = await connectionProvider();
         const gitApi = await connection.getGitApi();
         const thread = await gitApi.updateThread({ status: 2 }, // 2 corresponds to "Resolved" status
         repositoryId, pullRequestId, threadId);
+        // Check if the thread was successfully resolved
+        if (!thread) {
+            return {
+                content: [{ type: "text", text: `Error: Failed to resolve thread ${threadId}. The thread status was not updated successfully.` }],
+                isError: true,
+            };
+        }
+        if (fullResponse) {
+            return {
+                content: [{ type: "text", text: JSON.stringify(thread, null, 2) }],
+            };
+        }
         return {
-            content: [{ type: "text", text: JSON.stringify(thread, null, 2) }],
+            content: [{ type: "text", text: `Thread ${threadId} was successfully resolved.` }],
         };
     });
     const gitVersionTypeStrings = Object.values(GitVersionType).filter((value) => typeof value === "string");

package/dist/tools/search.js

@@ -10,38 +10,37 @@ const SEARCH_TOOLS = {
     search_workitem: "search_workitem",
 };
 function configureSearchTools(server, tokenProvider, connectionProvider, userAgentProvider) {
-    /*
-      CODE SEARCH
-      Get the code search results for a given search text.
-    */
-    server.tool(SEARCH_TOOLS.search_code, "Get the code search results for a given search text.", {
-        searchRequest: z
-            .object({
-            searchText: z.string().describe("Search text to find in code"),
-            $skip: z.number().default(0).describe("Number of results to skip (for pagination)"),
-            $top: z.number().default(5).describe("Number of results to return (for pagination)"),
-            filters: z
-                .object({
-                Project: z.array(z.string()).optional().describe("Filter in these projects"),
-                Repository: z.array(z.string()).optional().describe("Filter in these repositories"),
-                Path: z.array(z.string()).optional().describe("Filter in these paths"),
-                Branch: z.array(z.string()).optional().describe("Filter in these branches"),
-                CodeElement: z.array(z.string()).optional().describe("Filter for these code elements (e.g., classes, functions, symbols)"),
-                // Note: CodeElement is optional and can be used to filter results by specific code elements.
-                // It can be a string or an array of strings.
-                // If provided, the search will only return results that match the specified code elements.
-                // This is useful for narrowing down the search to specific classes, functions, definitions, or symbols.
-                // Example: CodeElement: ["MyClass", "MyFunction"]
-            })
-                .partial()
-                .optional(),
-            includeFacets: z.boolean().optional(),
-        })
-            .strict(),
-    }, async ({ searchRequest }) => {
+    server.tool(SEARCH_TOOLS.search_code, "Search Azure DevOps Repositories for a given search text", {
+        searchText: z.string().describe("Keywords to search for in code repositories"),
+        project: z.array(z.string()).optional().describe("Filter by projects"),
+        repository: z.array(z.string()).optional().describe("Filter by repositories"),
+        path: z.array(z.string()).optional().describe("Filter by paths"),
+        branch: z.array(z.string()).optional().describe("Filter by branches"),
+        includeFacets: z.boolean().default(false).describe("Include facets in the search results"),
+        skip: z.number().default(0).describe("Number of results to skip"),
+        top: z.number().default(5).describe("Maximum number of results to return"),
+    }, async ({ searchText, project, repository, path, branch, includeFacets, skip, top }) => {
         const accessToken = await tokenProvider();
         const connection = await connectionProvider();
         const url = `https://almsearch.dev.azure.com/${orgName}/_apis/search/codesearchresults?api-version=${apiVersion}`;
+        const requestBody = {
+            searchText,
+            includeFacets,
+            $skip: skip,
+            $top: top,
+        };
+        const filters = {};
+        if (project && project.length > 0)
+            filters.Project = project;
+        if (repository && repository.length > 0)
+            filters.Repository = repository;
+        if (path && path.length > 0)
+            filters.Path = path;
+        if (branch && branch.length > 0)
+            filters.Branch = branch;
+        if (Object.keys(filters).length > 0) {
+            requestBody.filters = filters;
+        }
         const response = await fetch(url, {
             method: "POST",
             headers: {
@@ -49,44 +48,43 @@ function configureSearchTools(server, tokenProvider, connectionProvider, userAge
                 "Authorization": `Bearer ${accessToken.token}`,
                 "User-Agent": userAgentProvider(),
             },
-            body: JSON.stringify(searchRequest),
+            body: JSON.stringify(requestBody),
         });
         if (!response.ok) {
             throw new Error(`Azure DevOps Code Search API error: ${response.status} ${response.statusText}`);
         }
         const resultText = await response.text();
         const resultJson = JSON.parse(resultText);
-        const topResults = Array.isArray(resultJson.results) ? resultJson.results.slice(0, Math.min(searchRequest.$top, resultJson.results.length)) : [];
         const gitApi = await connection.getGitApi();
-        const combinedResults = await fetchCombinedResults(topResults, gitApi);
+        const combinedResults = await fetchCombinedResults(resultJson.results ?? [], gitApi);
         return {
             content: [{ type: "text", text: resultText + JSON.stringify(combinedResults) }],
         };
     });
-    /*
-    WIKI SEARCH
-    Get wiki search results for a given search text.
-  */
-    server.tool(SEARCH_TOOLS.search_wiki, "Get wiki search results for a given search text.", {
-        searchRequest: z
-            .object({
-            searchText: z.string().describe("Search text to find in wikis"),
-            $skip: z.number().default(0).describe("Number of results to skip (for pagination)"),
-            $top: z.number().default(10).describe("Number of results to return (for pagination)"),
-            filters: z
-                .object({
-                Project: z.array(z.string()).optional().describe("Filter in these projects"),
-                Wiki: z.array(z.string()).optional().describe("Filter in these wiki names"),
-            })
-                .partial()
-                .optional()
-                .describe("Filters to apply to the search text"),
-            includeFacets: z.boolean().optional(),
-        })
-            .strict(),
-    }, async ({ searchRequest }) => {
+    server.tool(SEARCH_TOOLS.search_wiki, "Search Azure DevOps Wiki for a given search text", {
+        searchText: z.string().describe("Keywords to search for wiki pages"),
+        project: z.array(z.string()).optional().describe("Filter by projects"),
+        wiki: z.array(z.string()).optional().describe("Filter by wiki names"),
+        includeFacets: z.boolean().default(false).describe("Include facets in the search results"),
+        skip: z.number().default(0).describe("Number of results to skip"),
+        top: z.number().default(10).describe("Maximum number of results to return"),
+    }, async ({ searchText, project, wiki, includeFacets, skip, top }) => {
         const accessToken = await tokenProvider();
         const url = `https://almsearch.dev.azure.com/${orgName}/_apis/search/wikisearchresults?api-version=${apiVersion}`;
+        const requestBody = {
+            searchText,
+            includeFacets,
+            $skip: skip,
+            $top: top,
+        };
+        const filters = {};
+        if (project && project.length > 0)
+            filters.Project = project;
+        if (wiki && wiki.length > 0)
+            filters.Wiki = wiki;
+        if (Object.keys(filters).length > 0) {
+            requestBody.filters = filters;
+        }
         const response = await fetch(url, {
             method: "POST",
             headers: {
@@ -94,7 +92,7 @@ function configureSearchTools(server, tokenProvider, connectionProvider, userAge
                 "Authorization": `Bearer ${accessToken.token}`,
                 "User-Agent": userAgentProvider(),
             },
-            body: JSON.stringify(searchRequest),
+            body: JSON.stringify(requestBody),
         });
         if (!response.ok) {
             throw new Error(`Azure DevOps Wiki Search API error: ${response.status} ${response.statusText}`);
@@ -104,32 +102,39 @@ function configureSearchTools(server, tokenProvider, connectionProvider, userAge
             content: [{ type: "text", text: result }],
         };
     });
-    /*
-    WORK ITEM SEARCH
-    Get work item search results for a given search text.
-  */
-    server.tool(SEARCH_TOOLS.search_workitem, "Get work item search results for a given search text.", {
-        searchRequest: z
-            .object({
-            searchText: z.string().describe("Search text to find in work items"),
-            $skip: z.number().default(0).describe("Number of results to skip for pagination"),
-            $top: z.number().default(10).describe("Number of results to return"),
-            filters: z
-                .object({
-                "System.TeamProject": z.array(z.string()).optional().describe("Filter by team project"),
-                "System.AreaPath": z.array(z.string()).optional().describe("Filter by area path"),
-                "System.WorkItemType": z.array(z.string()).optional().describe("Filter by work item type like Bug, Task, User Story"),
-                "System.State": z.array(z.string()).optional().describe("Filter by state"),
-                "System.AssignedTo": z.array(z.string()).optional().describe("Filter by assigned to"),
-            })
-                .partial()
-                .optional(),
-            includeFacets: z.boolean().optional(),
-        })
-            .strict(),
-    }, async ({ searchRequest }) => {
+    server.tool(SEARCH_TOOLS.search_workitem, "Get Azure DevOps Work Item search results for a given search text", {
+        searchText: z.string().describe("Search text to find in work items"),
+        project: z.array(z.string()).optional().describe("Filter by projects"),
+        areaPath: z.array(z.string()).optional().describe("Filter by area paths"),
+        workItemType: z.array(z.string()).optional().describe("Filter by work item types"),
+        state: z.array(z.string()).optional().describe("Filter by work item states"),
+        assignedTo: z.array(z.string()).optional().describe("Filter by assigned to users"),
+        includeFacets: z.boolean().default(false).describe("Include facets in the search results"),
+        skip: z.number().default(0).describe("Number of results to skip for pagination"),
+        top: z.number().default(10).describe("Number of results to return"),
+    }, async ({ searchText, project, areaPath, workItemType, state, assignedTo, includeFacets, skip, top }) => {
         const accessToken = await tokenProvider();
         const url = `https://almsearch.dev.azure.com/${orgName}/_apis/search/workitemsearchresults?api-version=${apiVersion}`;
+        const requestBody = {
+            searchText,
+            includeFacets,
+            $skip: skip,
+            $top: top,
+        };
+        const filters = {};
+        if (project && project.length > 0)
+            filters["System.TeamProject"] = project;
+        if (areaPath && areaPath.length > 0)
+            filters["System.AreaPath"] = areaPath;
+        if (workItemType && workItemType.length > 0)
+            filters["System.WorkItemType"] = workItemType;
+        if (state && state.length > 0)
+            filters["System.State"] = state;
+        if (assignedTo && assignedTo.length > 0)
+            filters["System.AssignedTo"] = assignedTo;
+        if (Object.keys(filters).length > 0) {
+            requestBody.filters = filters;
+        }
         const response = await fetch(url, {
             method: "POST",
             headers: {
@@ -137,7 +142,7 @@ function configureSearchTools(server, tokenProvider, connectionProvider, userAge
                 "Authorization": `Bearer ${accessToken.token}`,
                 "User-Agent": userAgentProvider(),
             },
-            body: JSON.stringify(searchRequest),
+            body: JSON.stringify(requestBody),
         });
         if (!response.ok) {
             throw new Error(`Azure DevOps Work Item Search API error: ${response.status} ${response.statusText}`);