@azure-devops/mcp 1.1.0 → 1.2.0

package/dist/tools/releases.js

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 import { ReleaseDefinitionExpands, ReleaseDefinitionQueryOrder, ReleaseExpands, ReleaseStatus, ReleaseQueryOrder } from "azure-devops-node-api/interfaces/ReleaseInterfaces.js";
 import { z } from "zod";
+import { getEnumKeys, safeEnumConvert } from "../utils.js";
 const RELEASE_TOOLS = {
     get_release_definitions: "release_get_definitions",
     get_releases: "release_get_releases",
@@ -10,12 +11,18 @@ function configureReleaseTools(server, tokenProvider, connectionProvider) {
     server.tool(RELEASE_TOOLS.get_release_definitions, "Retrieves list of release definitions for a given project.", {
         project: z.string().describe("Project ID or name to get release definitions for"),
         searchText: z.string().optional().describe("Search text to filter release definitions"),
-        expand: z.nativeEnum(ReleaseDefinitionExpands).default(ReleaseDefinitionExpands.None).describe("Expand options for release definitions"),
+        expand: z
+            .enum(getEnumKeys(ReleaseDefinitionExpands))
+            .default("None")
+            .describe("Expand options for release definitions"),
         artifactType: z.string().optional().describe("Filter by artifact type"),
         artifactSourceId: z.string().optional().describe("Filter by artifact source ID"),
         top: z.number().optional().describe("Number of results to return (for pagination)"),
         continuationToken: z.string().optional().describe("Continuation token for pagination"),
-        queryOrder: z.nativeEnum(ReleaseDefinitionQueryOrder).default(ReleaseDefinitionQueryOrder.NameAscending).describe("Order of the results"),
+        queryOrder: z
+            .enum(getEnumKeys(ReleaseDefinitionQueryOrder))
+            .default("NameAscending")
+            .describe("Order of the results"),
         path: z.string().optional().describe("Path to filter release definitions"),
         isExactNameMatch: z.boolean().optional().default(false).describe("Whether to match the exact name of the release definition. Default is false."),
         tagFilter: z.array(z.string()).optional().describe("Filter by tags associated with the release definitions"),
@@ -26,7 +33,7 @@ function configureReleaseTools(server, tokenProvider, connectionProvider) {
     }, async ({ project, searchText, expand, artifactType, artifactSourceId, top, continuationToken, queryOrder, path, isExactNameMatch, tagFilter, propertyFilters, definitionIdFilter, isDeleted, searchTextContainsFolderName, }) => {
         const connection = await connectionProvider();
         const releaseApi = await connection.getReleaseApi();
-        const releaseDefinitions = await releaseApi.getReleaseDefinitions(project, searchText, expand, artifactType, artifactSourceId, top, continuationToken, queryOrder, path, isExactNameMatch, tagFilter, propertyFilters, definitionIdFilter, isDeleted, searchTextContainsFolderName);
+        const releaseDefinitions = await releaseApi.getReleaseDefinitions(project, searchText, safeEnumConvert(ReleaseDefinitionExpands, expand), artifactType, artifactSourceId, top, continuationToken, safeEnumConvert(ReleaseDefinitionQueryOrder, queryOrder), path, isExactNameMatch, tagFilter, propertyFilters, definitionIdFilter, isDeleted, searchTextContainsFolderName);
         return {
             content: [{ type: "text", text: JSON.stringify(releaseDefinitions, null, 2) }],
         };
@@ -37,7 +44,11 @@ function configureReleaseTools(server, tokenProvider, connectionProvider) {
         definitionEnvironmentId: z.number().optional().describe("ID of the definition environment to filter releases"),
         searchText: z.string().optional().describe("Search text to filter releases"),
         createdBy: z.string().optional().describe("User ID or name who created the release"),
-        statusFilter: z.nativeEnum(ReleaseStatus).optional().default(ReleaseStatus.Active).describe("Status of the releases to filter (default: Active)"),
+        statusFilter: z
+            .enum(getEnumKeys(ReleaseStatus))
+            .optional()
+            .default("Active")
+            .describe("Status of the releases to filter (default: Active)"),
         environmentStatusFilter: z.number().optional().describe("Environment status to filter releases"),
         minCreatedTime: z.coerce
             .date()
@@ -53,10 +64,18 @@ function configureReleaseTools(server, tokenProvider, connectionProvider) {
             .optional()
             .default(() => new Date())
             .describe("Maximum created time for releases (default: now)"),
-        queryOrder: z.nativeEnum(ReleaseQueryOrder).optional().default(ReleaseQueryOrder.Ascending).describe("Order in which to return releases (default: Ascending)"),
+        queryOrder: z
+            .enum(getEnumKeys(ReleaseQueryOrder))
+            .optional()
+            .default("Ascending")
+            .describe("Order in which to return releases (default: Ascending)"),
         top: z.number().optional().describe("Number of releases to return"),
         continuationToken: z.number().optional().describe("Continuation token for pagination"),
-        expand: z.nativeEnum(ReleaseExpands).optional().default(ReleaseExpands.None).describe("Expand options for releases"),
+        expand: z
+            .enum(getEnumKeys(ReleaseExpands))
+            .optional()
+            .default("None")
+            .describe("Expand options for releases"),
         artifactTypeId: z.string().optional().describe("Filter releases by artifact type ID"),
         sourceId: z.string().optional().describe("Filter releases by artifact source ID"),
         artifactVersionId: z.string().optional().describe("Filter releases by artifact version ID"),
@@ -69,7 +88,7 @@ function configureReleaseTools(server, tokenProvider, connectionProvider) {
     }, async ({ project, definitionId, definitionEnvironmentId, searchText, createdBy, statusFilter, environmentStatusFilter, minCreatedTime, maxCreatedTime, queryOrder, top, continuationToken, expand, artifactTypeId, sourceId, artifactVersionId, sourceBranchFilter, isDeleted, tagFilter, propertyFilters, releaseIdFilter, path, }) => {
         const connection = await connectionProvider();
         const releaseApi = await connection.getReleaseApi();
-        const releases = await releaseApi.getReleases(project, definitionId, definitionEnvironmentId, searchText, createdBy, statusFilter, environmentStatusFilter, minCreatedTime, maxCreatedTime, queryOrder, top, continuationToken, expand, artifactTypeId, sourceId, artifactVersionId, sourceBranchFilter, isDeleted, tagFilter, propertyFilters, releaseIdFilter, path);
+        const releases = await releaseApi.getReleases(project, definitionId, definitionEnvironmentId, searchText, createdBy, safeEnumConvert(ReleaseStatus, statusFilter), environmentStatusFilter, minCreatedTime, maxCreatedTime, safeEnumConvert(ReleaseQueryOrder, queryOrder), top, continuationToken, safeEnumConvert(ReleaseExpands, expand), artifactTypeId, sourceId, artifactVersionId, sourceBranchFilter, isDeleted, tagFilter, propertyFilters, releaseIdFilter, path);
         return {
             content: [{ type: "text", text: JSON.stringify(releases, null, 2) }],
         };

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",
@@ -16,6 +17,7 @@ const REPO_TOOLS = {
     get_pull_request_by_id: "repo_get_pull_request_by_id",
     create_pull_request: "repo_create_pull_request",
     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",
     resolve_comment: "repo_resolve_comment",
     search_commits: "repo_search_commits",
@@ -31,15 +33,15 @@ function branchesFilterOutIrrelevantProperties(branches, top) {
 }
 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}`);
@@ -78,16 +80,40 @@ 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) }],
         };
     });
+    server.tool(REPO_TOOLS.update_pull_request_reviewers, "Add or remove reviewers for an existing pull request.", {
+        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 update."),
+        reviewerIds: z.array(z.string()).describe("List of reviewer ids to add or remove from the pull request."),
+        action: z.enum(["add", "remove"]).describe("Action to perform on the reviewers. Can be 'add' or 'remove'."),
+    }, async ({ repositoryId, pullRequestId, reviewerIds, action }) => {
+        const connection = await connectionProvider();
+        const gitApi = await connection.getGitApi();
+        let updatedPullRequest;
+        if (action === "add") {
+            updatedPullRequest = await gitApi.createPullRequestReviewers(reviewerIds.map((id) => ({ id: id })), repositoryId, pullRequestId);
+            return {
+                content: [{ type: "text", text: JSON.stringify(updatedPullRequest, null, 2) }],
+            };
+        }
+        else {
+            for (const reviewerId of reviewerIds) {
+                await gitApi.deletePullRequestReviewer(repositoryId, pullRequestId, reviewerId);
+            }
+            return {
+                content: [{ type: "text", text: `Reviewers with IDs ${reviewerIds.join(", ")} removed from pull request ${pullRequestId}.` }],
+            };
+        }
+    });
     server.tool(REPO_TOOLS.list_repos_by_project, "Retrieve a list of repositories for a given project", {
         project: z.string().describe("The name or ID of the Azure DevOps project."),
         top: z.number().default(100).describe("The maximum number of repositories to return."),
@@ -119,7 +145,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();
@@ -164,7 +193,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();

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,
+            $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,
+            $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,
+            $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}`);