Add pull request update tool (#361)

beauzeaux · web-flow · commit 78a1e3686835 · 2025-07-31T14:38:57.000+02:00
- Add repo_update_pull_request tool for updating PR title, description, draft status, and target branch - Update documentation to reflect new tool capabilities - Add validation to ensure at least one field is provided for update - Support partial updates with optional parameters ## GitHub issue number [322](#322) ## **Associated Risks** - May cause confusion with similar `update_pull_request_status` and `update_pull_request_reviewers`, neither of those operations can be accomplished with the underlying API ## ✅ **PR Checklist** - [x] **I have read the [contribution guidelines](https://github.com/microsoft/azure-devops-mcp/blob/main/CONTRIBUTING.md)** - [x] **I have read the [code of conduct guidelines](https://github.com/microsoft/azure-devops-mcp/blob/main/CODE_OF_CONDUCT.md)** - [x] Title of the pull request is clear and informative. - [x] 👌 Code hygiene - [x] 🔭 Telemetry added, updated, or N/A - [x] 📄 Documentation added, updated, or N/A - [x] 🛡️ Automated tests added, or N/A ## 🧪 **How did you test it?** - Been using it for a little over a week for personal uses. - src/tools/repos.test.ts (some very loose unit tests I let copilot author)
diff --git a/README.md b/README.md
@@ -95,6 +95,7 @@ Interact with these Azure DevOps services:
 - **repo_get_pull_request_by_id**: Get a pull request by its ID.
 - **repo_create_pull_request**: Create a new pull request.
 - **repo_update_pull_request_status**: Update the status of an existing pull request to active or abandoned.
+- **repo_update_pull_request**: Update various fields of an existing pull request (title, description, draft status, target branch).
 - **repo_update_pull_request_reviewers**: Add or remove reviewers for an existing pull request.
 - **repo_reply_to_comment**: Replies to a specific comment on a pull request.
 - **repo_resolve_comment**: Resolves a specific comment thread on a pull request.
diff --git a/src/tools/repos.ts b/src/tools/repos.ts
@@ -34,7 +34,7 @@ const REPO_TOOLS = {
   get_branch_by_name: "repo_get_branch_by_name",
   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: "repo_update_pull_request",
   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",
@@ -144,19 +144,46 @@ function configureRepoTools(server: McpServer, tokenProvider: () => Promise<Acce
   );
 
   server.tool(
-    REPO_TOOLS.update_pull_request_status,
-    "Update status of an existing pull request to active or abandoned.",
+    REPO_TOOLS.update_pull_request,
+    "Update a Pull Request by ID with specified fields.",
     {
       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'."),
+      pullRequestId: z.number().describe("The ID of the pull request to update."),
+      title: z.string().optional().describe("The new title for the pull request."),
+      description: z.string().optional().describe("The new description for the pull request."),
+      isDraft: z.boolean().optional().describe("Whether the pull request should be a draft."),
+      targetRefName: z.string().optional().describe("The new target branch name (e.g., 'refs/heads/main')."),
+      status: z.enum(["Active", "Abandoned"]).optional().describe("The new status of the pull request. Can be 'Active' or 'Abandoned'."),
     },
-    async ({ repositoryId, pullRequestId, status }) => {
+    async ({ repositoryId, pullRequestId, title, description, isDraft, targetRefName, status }) => {
       const connection = await connectionProvider();
       const gitApi = await connection.getGitApi();
-      const statusValue = status === "Active" ? PullRequestStatus.Active.valueOf() : PullRequestStatus.Abandoned.valueOf();
 
-      const updatedPullRequest = await gitApi.updatePullRequest({ status: statusValue }, repositoryId, pullRequestId);
+      // Build update object with only provided fields
+      const updateRequest: {
+        title?: string;
+        description?: string;
+        isDraft?: boolean;
+        targetRefName?: string;
+        status?: number;
+      } = {};
+      if (title !== undefined) updateRequest.title = title;
+      if (description !== undefined) updateRequest.description = description;
+      if (isDraft !== undefined) updateRequest.isDraft = isDraft;
+      if (targetRefName !== undefined) updateRequest.targetRefName = targetRefName;
+      if (status !== undefined) {
+        updateRequest.status = status === "Active" ? PullRequestStatus.Active.valueOf() : PullRequestStatus.Abandoned.valueOf();
+      }
+
+      // Validate that at least one field is provided for update
+      if (Object.keys(updateRequest).length === 0) {
+        return {
+          content: [{ type: "text", text: "Error: At least one field (title, description, isDraft, targetRefName, or status) must be provided for update." }],
+          isError: true,
+        };
+      }
+
+      const updatedPullRequest = await gitApi.updatePullRequest(updateRequest, repositoryId, pullRequestId);
 
       return {
         content: [{ type: "text", text: JSON.stringify(updatedPullRequest, null, 2) }],
diff --git a/test/src/tools/repos.test.ts b/test/src/tools/repos.test.ts
@@ -0,0 +1,225 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { AccessToken } from "@azure/identity";
+import { WebApi } from "azure-devops-node-api";
+import { configureRepoTools, REPO_TOOLS } from "../../../src/tools/repos";
+
+// Mock the auth module
+jest.mock("../../../src/tools/auth", () => ({
+  getCurrentUserDetails: jest.fn(),
+}));
+
+describe("repos tools", () => {
+  let server: McpServer;
+  let tokenProvider: jest.MockedFunction<() => Promise<AccessToken>>;
+  let connectionProvider: jest.MockedFunction<() => Promise<WebApi>>;
+  let mockGitApi: {
+    updatePullRequest: jest.MockedFunction<(...args: unknown[]) => Promise<unknown>>;
+  };
+
+  beforeEach(() => {
+    server = {
+      tool: jest.fn(),
+    } as unknown as McpServer;
+
+    tokenProvider = jest.fn();
+    mockGitApi = {
+      updatePullRequest: jest.fn(),
+    };
+
+    connectionProvider = jest.fn().mockResolvedValue({
+      getGitApi: jest.fn().mockResolvedValue(mockGitApi),
+    });
+  });
+
+  describe("repo_update_pull_request", () => {
+    it("should update pull request with all provided fields", async () => {
+      configureRepoTools(server, tokenProvider, connectionProvider);
+
+      const call = (server.tool as jest.Mock).mock.calls.find(([toolName]) => toolName === REPO_TOOLS.update_pull_request);
+
+      if (!call) throw new Error("repo_update_pull_request tool not registered");
+      const [, , , handler] = call;
+
+      const mockUpdatedPR = {
+        pullRequestId: 123,
+        title: "Updated Title",
+        description: "Updated Description",
+        isDraft: true,
+      };
+      mockGitApi.updatePullRequest.mockResolvedValue(mockUpdatedPR);
+
+      const params = {
+        repositoryId: "repo123",
+        pullRequestId: 123,
+        title: "Updated Title",
+        description: "Updated Description",
+        isDraft: true,
+        targetRefName: "refs/heads/main",
+      };
+
+      const result = await handler(params);
+
+      expect(mockGitApi.updatePullRequest).toHaveBeenCalledWith(
+        {
+          title: "Updated Title",
+          description: "Updated Description",
+          isDraft: true,
+          targetRefName: "refs/heads/main",
+        },
+        "repo123",
+        123
+      );
+
+      expect(result.content[0].text).toBe(JSON.stringify(mockUpdatedPR, null, 2));
+    });
+
+    it("should update pull request with only title", async () => {
+      configureRepoTools(server, tokenProvider, connectionProvider);
+
+      const call = (server.tool as jest.Mock).mock.calls.find(([toolName]) => toolName === REPO_TOOLS.update_pull_request);
+
+      if (!call) throw new Error("repo_update_pull_request tool not registered");
+      const [, , , handler] = call;
+
+      const mockUpdatedPR = { pullRequestId: 123, title: "New Title" };
+      mockGitApi.updatePullRequest.mockResolvedValue(mockUpdatedPR);
+
+      const params = {
+        repositoryId: "repo123",
+        pullRequestId: 123,
+        title: "New Title",
+      };
+
+      const result = await handler(params);
+
+      expect(mockGitApi.updatePullRequest).toHaveBeenCalledWith(
+        {
+          title: "New Title",
+        },
+        "repo123",
+        123
+      );
+
+      expect(result.content[0].text).toBe(JSON.stringify(mockUpdatedPR, null, 2));
+    });
+
+    it("should update pull request status to Active", async () => {
+      configureRepoTools(server, tokenProvider, connectionProvider);
+
+      const call = (server.tool as jest.Mock).mock.calls.find(([toolName]) => toolName === REPO_TOOLS.update_pull_request);
+
+      if (!call) throw new Error("repo_update_pull_request tool not registered");
+      const [, , , handler] = call;
+
+      const mockUpdatedPR = { pullRequestId: 123, status: 1 }; // Active status
+      mockGitApi.updatePullRequest.mockResolvedValue(mockUpdatedPR);
+
+      const params = {
+        repositoryId: "repo123",
+        pullRequestId: 123,
+        status: "Active" as const,
+      };
+
+      const result = await handler(params);
+
+      expect(mockGitApi.updatePullRequest).toHaveBeenCalledWith(
+        {
+          status: 1, // PullRequestStatus.Active
+        },
+        "repo123",
+        123
+      );
+
+      expect(result.content[0].text).toBe(JSON.stringify(mockUpdatedPR, null, 2));
+    });
+
+    it("should update pull request status to Abandoned", async () => {
+      configureRepoTools(server, tokenProvider, connectionProvider);
+
+      const call = (server.tool as jest.Mock).mock.calls.find(([toolName]) => toolName === REPO_TOOLS.update_pull_request);
+
+      if (!call) throw new Error("repo_update_pull_request tool not registered");
+      const [, , , handler] = call;
+
+      const mockUpdatedPR = { pullRequestId: 123, status: 2 }; // Abandoned status
+      mockGitApi.updatePullRequest.mockResolvedValue(mockUpdatedPR);
+
+      const params = {
+        repositoryId: "repo123",
+        pullRequestId: 123,
+        status: "Abandoned" as const,
+      };
+
+      const result = await handler(params);
+
+      expect(mockGitApi.updatePullRequest).toHaveBeenCalledWith(
+        {
+          status: 2, // PullRequestStatus.Abandoned
+        },
+        "repo123",
+        123
+      );
+
+      expect(result.content[0].text).toBe(JSON.stringify(mockUpdatedPR, null, 2));
+    });
+
+    it("should update pull request with status and other fields", async () => {
+      configureRepoTools(server, tokenProvider, connectionProvider);
+
+      const call = (server.tool as jest.Mock).mock.calls.find(([toolName]) => toolName === REPO_TOOLS.update_pull_request);
+
+      if (!call) throw new Error("repo_update_pull_request tool not registered");
+      const [, , , handler] = call;
+
+      const mockUpdatedPR = {
+        pullRequestId: 123,
+        title: "Updated Title",
+        status: 1,
+      };
+      mockGitApi.updatePullRequest.mockResolvedValue(mockUpdatedPR);
+
+      const params = {
+        repositoryId: "repo123",
+        pullRequestId: 123,
+        title: "Updated Title",
+        status: "Active" as const,
+      };
+
+      const result = await handler(params);
+
+      expect(mockGitApi.updatePullRequest).toHaveBeenCalledWith(
+        {
+          title: "Updated Title",
+          status: 1, // PullRequestStatus.Active
+        },
+        "repo123",
+        123
+      );
+
+      expect(result.content[0].text).toBe(JSON.stringify(mockUpdatedPR, null, 2));
+    });
+
+    it("should return error when no fields provided", async () => {
+      configureRepoTools(server, tokenProvider, connectionProvider);
+
+      const call = (server.tool as jest.Mock).mock.calls.find(([toolName]) => toolName === REPO_TOOLS.update_pull_request);
+
+      if (!call) throw new Error("repo_update_pull_request tool not registered");
+      const [, , , handler] = call;
+
+      const params = {
+        repositoryId: "repo123",
+        pullRequestId: 123,
+      };
+
+      const result = await handler(params);
+
+      expect(mockGitApi.updatePullRequest).not.toHaveBeenCalled();
+      expect(result.isError).toBe(true);
+      expect(result.content[0].text).toContain("At least one field (title, description, isDraft, targetRefName, or status) must be provided for update.");
+    });
+  });
+});
