Skip to content

Add updating draft state to update_pull_request tool #774

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
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

mattdholloway
Copy link
Contributor

@mattdholloway mattdholloway commented Jul 28, 2025

Closes: #501 and #423

This is a copy of the comment in issue 501:

I've had a look at implementing this as an extension of the update_pull_request tool (using GraphQL). I've chosen to use a new draft parameter as a boolean for this for a few reasons:

  • In the GraphQL spec for pull requests, 'draft' is separate to 'state' as a PR can be both closed as a draft, open as ready for review, etc (ref:
"""
The possible states of a pull request.
"""
enum PullRequestState {
  """
  A pull request that has been closed without being merged.
  """
  CLOSED

  """
  A pull request that has been closed by being merged.
  """
  MERGED

  """
  A pull request that is still open.
  """
  OPEN
}
  Identifies if the pull request is a draft.
  """
  isDraft: Boolean!

  """
  • Setting if the PR is a draft using GraphQL requires a separate implementation to the current existing REST calls, and I felt it would introduce unneeded complexity having a totally separate code path based on an enum variant

@mattdholloway mattdholloway marked this pull request as ready for review July 28, 2025 15:23
@Copilot Copilot AI review requested due to automatic review settings July 28, 2025 15:23
@mattdholloway mattdholloway requested a review from a team as a code owner July 28, 2025 15:23
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds draft state management capability to the update_pull_request tool, allowing users to convert pull requests between draft and ready-for-review states using the GitHub GraphQL API.

  • Adds a new draft parameter to the tool's input schema
  • Implements GraphQL mutations for converting between draft and ready-for-review states
  • Updates tests and documentation to reflect the new functionality

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
pkg/github/tools.go Updates tool registration to include GraphQL client parameter
pkg/github/pullrequests.go Implements draft state management logic using GraphQL mutations
pkg/github/pullrequests_test.go Updates tests to include the new draft parameter and GraphQL client
pkg/github/toolsnaps/update_pull_request.snap Adds draft parameter to tool schema snapshot
README.md Documents the new draft parameter in the tool description

return mcp.NewToolResultError("No update parameters provided."), nil
}

if restUpdateNeeded {
Copy link
Preview

Copilot AI Jul 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The conditional block structure creates an unbalanced indentation flow. Consider extracting the REST API update logic into a separate function to improve readability and maintainability.

Note: See the diff below for a potential fix:

@@ -308,28 +308,10 @@
 			}
 
 			if restUpdateNeeded {
-				client, err := getClient(ctx)
+				result, err := updatePullRequest(ctx, getClient, owner, repo, pullNumber, update)
 				if err != nil {
-					return nil, fmt.Errorf("failed to get GitHub client: %w", err)
+					return result, err
 				}
-
-				_, resp, err := client.PullRequests.Edit(ctx, owner, repo, pullNumber, update)
-				if err != nil {
-					return ghErrors.NewGitHubAPIErrorResponse(ctx,
-						"failed to update pull request",
-						resp,
-						err,
-					), nil
-				}
-				defer func() { _ = resp.Body.Close() }()
-
-				if resp.StatusCode != http.StatusOK {
-					body, err := io.ReadAll(resp.Body)
-					if err != nil {
-						return nil, fmt.Errorf("failed to read response body: %w", err)
-					}
-					return mcp.NewToolResultError(fmt.Sprintf("failed to update pull request: %s", string(body))), nil
-				}
 			}
 
 			if draftProvided {

Copilot uses AI. Check for mistakes.

client, err := getClient(ctx)
if err != nil {
return nil, fmt.Errorf("failed to get GitHub client: %w", err)
return nil, err
Copy link
Preview

Copilot AI Jul 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The REST client is retrieved twice in this function - once for the conditional update and again at the end. Consider reusing the client instance or restructuring the code to avoid duplicate client retrieval.

Suggested change
return nil, err
finalPR, resp, err := client.REST.PullRequests.Get(ctx, owner, repo, pullNumber)
if err != nil {
return ghErrors.NewGitHubAPIErrorResponse(ctx, "Failed to get pull request", resp, err), nil

Copilot uses AI. Check for mistakes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow tool to mark PR ready for review
1 participant