Sitelet https://github.com/github/github-mcp-server/pull/3852/files
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1332,6 +1332,7 @@ For negotiated supported protocol versions `2026-07-28` or newer, the consolidat

- **merge_pull_request** - Merge pull request
- **OAuth Challenge Scopes**: `repo`
- `author_email`: Email address to associate with the merge commit (string, optional)
- `commit_message`: Extra detail for merge commit (string, optional)
- `commit_title`: Title for merge commit (string, optional)
- `expectedHeadSha`: The expected SHA of the pull request's HEAD ref (string, optional)
Expand Down
4 changes: 4 additions & 0 deletions pkg/github/__toolsnaps__/merge_pull_request.snap
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@
],
"inputSchema": {
"properties": {
"author_email": {
"description": "Email address to associate with the merge commit",
"type": "string"
},
"commit_message": {
"description": "Extra detail for merge commit",
"type": "string"
Expand Down
3 changes: 2 additions & 1 deletion pkg/github/consolidated_pull_request_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ type MergePullRequestInput struct {
CommitMessage *string `json:"commit_message,omitempty"`
MergeMethod *string `json:"merge_method,omitempty"`
ExpectedHeadSHA *string `json:"expectedHeadSha,omitempty"`
AuthorEmail *string `json:"author_email,omitempty"`
}

type UpdatePullRequestBranchInput struct {
Expand Down Expand Up @@ -429,7 +430,7 @@ var pullRequestArgumentSpecs = map[string]pullRequestArgumentSpec{
},
"merge": {
required: []string{"owner", "repo"}, requiredInts: []string{"pullNumber"},
strings: []string{"commit_title", "commit_message", "merge_method", "expectedHeadSha"},
strings: []string{"commit_title", "commit_message", "merge_method", "expectedHeadSha", "author_email"},
},
"branch": {
required: []string{"owner", "repo"}, requiredInts: []string{"pullNumber"}, strings: []string{"expectedHeadSha"},
Expand Down
82 changes: 82 additions & 0 deletions pkg/github/pullrequests.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ import (
"encoding/json"
"fmt"
"io"
"math"
"net/http"
"slices"
"strings"

"github.com/go-viper/mapstructure/v2"
"github.com/google/go-github/v92/github"
Expand Down Expand Up @@ -1692,6 +1694,10 @@ func MergePullRequest(t translations.TranslationHelperFunc) inventory.ServerTool
Type: "string",
Description: "Extra detail for merge commit",
},
"author_email": {
Type: "string",
Description: "Email address to associate with the merge commit",
},
"merge_method": {
Type: "string",
Description: "Merge method",
Expand Down Expand Up @@ -1758,6 +1764,9 @@ func MergePullRequest(t translations.TranslationHelperFunc) inventory.ServerTool
SHA: expectedHeadSHA,
MergeMethod: mergeMethod,
}
if input.AuthorEmail != nil && *input.AuthorEmail != "" {
return mergePullRequestWithAuthorEmail(ctx, deps, input)
}

client, err := deps.GetClient(ctx)
if err != nil {
Expand Down Expand Up @@ -1794,6 +1803,79 @@ func MergePullRequest(t translations.TranslationHelperFunc) inventory.ServerTool
}, normalizePullRequestArguments("merge"))
}

func mergePullRequestWithAuthorEmail(ctx context.Context, deps ToolDependencies, input MergePullRequestInput) (*mcp.CallToolResult, *PullRequestMergeOutput, error) {
if input.PullNumber < 1 || input.PullNumber > math.MaxInt32 {
return utils.NewToolResultError("pullNumber must be between 1 and 2147483647"), nil, nil
}
client, err := deps.GetGQLClient(ctx)
if err != nil {
return utils.NewToolResultErrorFromErr("failed to get GitHub GraphQL client", err), nil, nil
}
var query struct {
Repository struct {
PullRequest struct {
ID githubv4.ID
} `graphql:"pullRequest(number: $prNum)"`
} `graphql:"repository(owner: $owner, name: $repo)"`
}
err = client.Query(ctx, &query, map[string]any{
"owner": githubv4.String(input.Owner),
"repo": githubv4.String(input.Repo),
"prNum": githubv4.Int(input.PullNumber),
})
if err != nil {
return ghErrors.NewGitHubGraphQLErrorResponse(ctx, "failed to find pull request", err), nil, nil
}
if query.Repository.PullRequest.ID == nil {
return utils.NewToolResultError("failed to find pull request"), nil, nil
}
mergeInput := githubv4.MergePullRequestInput{
PullRequestID: query.Repository.PullRequest.ID,
AuthorEmail: githubv4.NewString(githubv4.String(*input.AuthorEmail)),
}
if input.CommitTitle != nil && *input.CommitTitle != "" {
mergeInput.CommitHeadline = githubv4.NewString(githubv4.String(*input.CommitTitle))
}
if input.CommitMessage != nil && *input.CommitMessage != "" {
mergeInput.CommitBody = githubv4.NewString(githubv4.String(*input.CommitMessage))
}
if input.MergeMethod != nil && *input.MergeMethod != "" {
mergeInput.MergeMethod = new(githubv4.PullRequestMergeMethod(strings.ToUpper(*input.MergeMethod)))
}
if input.ExpectedHeadSHA != nil && *input.ExpectedHeadSHA != "" {
mergeInput.ExpectedHeadOid = new(githubv4.GitObjectID(*input.ExpectedHeadSHA))
}
var mutation struct {
MergePullRequest struct {
PullRequest struct {
Merged githubv4.Boolean
MergeCommit *struct {
OID githubv4.GitObjectID
}
}
} `graphql:"mergePullRequest(input: $input)"`
}
if err := client.Mutate(ctx, &mutation, mergeInput, nil); err != nil {
return ghErrors.NewGitHubGraphQLErrorResponse(ctx, "failed to merge pull request", err), nil, nil
}
pr := mutation.MergePullRequest.PullRequest
if !bool(pr.Merged) {
return utils.NewToolResultError("pull request was not merged"), nil, nil
}
result := &PullRequestMergeResult{
Merged: new(true),
Message: new("Pull Request successfully merged"),
}
if pr.MergeCommit != nil {
result.SHA = new(string(pr.MergeCommit.OID))
}
r, err := json.Marshal(result)
if err != nil {
return utils.NewToolResultErrorFromErr("failed to marshal response", err), nil, nil
}
return utils.NewToolResultText(string(r)), &PullRequestMergeOutput{Result: result}, nil
}

// SearchPullRequests creates a tool to search for pull requests.
func SearchPullRequests(t translations.TranslationHelperFunc) inventory.ServerTool {
schema := &jsonschema.Schema{
Expand Down
216 changes: 216 additions & 0 deletions pkg/github/pullrequests_merge_author_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,216 @@
package github

import (
"context"
"encoding/json"
"maps"
"net/http"
"strings"
"sync/atomic"
"testing"

"github.com/github/github-mcp-server/v2/internal/githubv4mock"
"github.com/github/github-mcp-server/v2/pkg/inventory"
"github.com/modelcontextprotocol/go-sdk/mcp"
"github.com/shurcooL/githubv4"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func Test_MergePullRequest_AuthorEmail(t *testing.T) {
tests := []struct {
name string
protocol string
args map[string]any
wantNumber githubv4.Int
wantInput map[string]any
queryError string
queryResult map[string]any
mutationError string
mergeResult map[string]any
expectedError string
}{
{name: "default merge method"},
{name: "legacy protocol text result", protocol: "2025-11-25"},
{name: "minimum pull number", args: map[string]any{"pullNumber": 1}, wantNumber: 1},
{name: "maximum pull number", args: map[string]any{"pullNumber": 2147483647}, wantNumber: 2147483647},
{name: "minimum numeric string", args: map[string]any{"pullNumber": "1"}, wantNumber: 1},
{name: "maximum numeric string", args: map[string]any{"pullNumber": "2147483647"}, wantNumber: 2147483647},
{
name: "merge",
args: map[string]any{"merge_method": "merge"},
wantInput: map[string]any{"mergeMethod": "MERGE"},
},
{
name: "squash with commit metadata and head guard",
args: map[string]any{
"merge_method": "squash", "commit_title": "Land feature",
"commit_message": "Details", "expectedHeadSha": "head-sha",
},
wantInput: map[string]any{
"mergeMethod": "SQUASH", "commitHeadline": "Land feature",
"commitBody": "Details", "expectedHeadOid": "head-sha",
},
},
{
name: "rebase",
args: map[string]any{"merge_method": "rebase"},
wantInput: map[string]any{"mergeMethod": "REBASE"},
},
{name: "lookup failure", queryError: "Could not resolve to a PullRequest"},
{
name: "missing pull request ID",
queryResult: map[string]any{"repository": map[string]any{"pullRequest": nil}},
expectedError: "failed to find pull request",
},
{name: "merge failure", mutationError: "Email is not verified"},
{
name: "missing merge result",
mergeResult: map[string]any{"pullRequest": nil},
expectedError: "pull request was not merged",
},
{
name: "pull request was not merged",
mergeResult: map[string]any{"pullRequest": map[string]any{"merged": false, "mergeCommit": nil}},
expectedError: "pull request was not merged",
},
{
name: "head mismatch",
args: map[string]any{"expectedHeadSha": "stale-sha"},
wantInput: map[string]any{"expectedHeadOid": "stale-sha"},
mutationError: "Head branch was modified",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
args := map[string]any{
"owner": "owner", "repo": "repo", "pullNumber": 42,
"author_email": "[email protected]",
}
maps.Copy(args, tc.args)
wantNumber := tc.wantNumber
if wantNumber == 0 {
wantNumber = 42
}
wantInput := map[string]any{"pullRequestId": "PR_42", "authorEmail": "[email protected]"}
maps.Copy(wantInput, tc.wantInput)
queryResponse := githubv4mock.DataResponse(map[string]any{
"repository": map[string]any{"pullRequest": map[string]any{"id": "PR_42"}},
})
if tc.queryError != "" {
queryResponse = githubv4mock.ErrorResponse(tc.queryError)
}
if tc.queryResult != nil {
queryResponse = githubv4mock.DataResponse(tc.queryResult)
}
mutationResponse := githubv4mock.DataResponse(map[string]any{
"mergePullRequest": map[string]any{"pullRequest": map[string]any{
"merged": true, "mergeCommit": map[string]any{"oid": "merge-sha"},
}},
})
if tc.mutationError != "" {
mutationResponse = githubv4mock.ErrorResponse(tc.mutationError)
}
if tc.mergeResult != nil {
mutationResponse = githubv4mock.DataResponse(map[string]any{"mergePullRequest": tc.mergeResult})
}
gqlClient := githubv4.NewClient(githubv4mock.NewMockedHTTPClient(
githubv4mock.NewQueryMatcher(
`query($owner:String!$prNum:Int!$repo:String!){repository(owner: $owner, name: $repo){pullRequest(number: $prNum){id}}}`,
map[string]any{"owner": githubv4.String("owner"), "repo": githubv4.String("repo"), "prNum": wantNumber},
queryResponse,
),
githubv4mock.NewQueryMatcher(
`mutation($input:MergePullRequestInput!){mergePullRequest(input: $input){pullRequest{merged,mergeCommit{oid}}}}`,
map[string]any{"input": wantInput},
mutationResponse,
),
))
deps := BaseDeps{
Client: mustNewGHClient(t, MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
PutReposPullsMergeByOwnerByRepoByPullNumber: func(w http.ResponseWriter, _ *http.Request) {
t.Error("author_email must not use the REST merge endpoint")
w.WriteHeader(http.StatusInternalServerError)
},
})),
GQLClient: gqlClient,
}
protocol := tc.protocol
if protocol == "" {
protocol = inventory.ProtocolVersionMultiRoundTrip
}
session, _ := consolidatedPullRequestSession(t, deps, protocol, false)
result, err := session.CallTool(context.Background(), &mcp.CallToolParams{Name: "merge_pull_request", Arguments: args})
require.NoError(t, err)
if tc.queryError != "" || tc.mutationError != "" || tc.expectedError != "" {
require.True(t, result.IsError)
assert.Contains(t, getErrorResult(t, result).Text, tc.queryError+tc.mutationError+tc.expectedError)
return
}
require.False(t, result.IsError, getTextResult(t, result).Text)
const want = `{"sha":"merge-sha","merged":true,"message":"Pull Request successfully merged"}`
assert.JSONEq(t, want, getTextResult(t, result).Text)
if protocol != inventory.ProtocolVersionMultiRoundTrip {
assert.Nil(t, result.StructuredContent)
return
}
structured, err := json.Marshal(result.StructuredContent)
require.NoError(t, err)
assert.JSONEq(t, want, string(structured))
})
}
}

func Test_MergePullRequest_AuthorEmail_InvalidPullNumber(t *testing.T) {
for _, protocol := range []string{inventory.ProtocolVersionMultiRoundTrip, "2025-11-25"} {
t.Run(protocol, func(t *testing.T) {
for _, tc := range []struct {
name string
pullNumber any
}{
{name: "zero", pullNumber: 0},
{name: "negative", pullNumber: -1},
{name: "above maximum", pullNumber: int64(2147483648)},
{name: "wraps to another pull request", pullNumber: int64(4294967338)},
{name: "negative numeric string", pullNumber: "-1"},
{name: "above maximum numeric string", pullNumber: "2147483648"},
{name: "numeric string wraps to another pull request", pullNumber: "4294967338"},
} {
t.Run(tc.name, func(t *testing.T) {
var requests atomic.Int32
httpClient := &http.Client{Transport: recorderTransport{handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
requests.Add(1)
var body struct {
Query string `json:"query"`
Variables map[string]any `json:"variables"`
}
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
t.Error(err)
w.WriteHeader(http.StatusBadRequest)
return
}
t.Logf("unexpected GitHub request: %s %v", body.Query, body.Variables)
response := `{"data":{"repository":{"pullRequest":{"id":"PR_42"}}}}`
if strings.HasPrefix(body.Query, "mutation") {
response = `{"data":{"mergePullRequest":{"pullRequest":{"merged":true,"mergeCommit":{"oid":"merge-sha"}}}}}`
}
_, err := w.Write([]byte(response))
assert.NoError(t, err)
})}}
deps := BaseDeps{Client: mustNewGHClient(t, httpClient), GQLClient: githubv4.NewClient(httpClient)}
session, _ := consolidatedPullRequestSession(t, deps, protocol, false)
result, err := session.CallTool(context.Background(), &mcp.CallToolParams{
Name: "merge_pull_request",
Arguments: map[string]any{
"owner": "owner", "repo": "repo", "pullNumber": tc.pullNumber,
"author_email": "[email protected]",
},
})
require.NoError(t, err)
assert.Zero(t, requests.Load(), "invalid pull numbers must not reach GitHub")
assert.True(t, result.IsError, "invalid pull numbers must fail instead of merging")
})
}
})
}
}
14 changes: 14 additions & 0 deletions pkg/github/pullrequests_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -837,6 +837,7 @@ func Test_MergePullRequest(t *testing.T) {
assert.Contains(t, schema.Properties, "commit_message")
assert.Contains(t, schema.Properties, "merge_method")
assert.Contains(t, schema.Properties, "expectedHeadSha")
assert.Contains(t, schema.Properties, "author_email")
assert.ElementsMatch(t, schema.Required, []string{"owner", "repo", "pullNumber"})

// Setup mock merge result for success case
Expand Down Expand Up @@ -876,6 +877,19 @@ func Test_MergePullRequest(t *testing.T) {
expectError: false,
expectedMergeResult: mockMergeResult,
},
{
name: "empty author email keeps REST merge and head guard",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
PutReposPullsMergeByOwnerByRepoByPullNumber: expectRequestBody(t, map[string]any{
"sha": "head-sha",
}).andThen(mockResponse(t, http.StatusOK, mockMergeResult)),
}),
requestArgs: map[string]any{
"owner": "owner", "repo": "repo", "pullNumber": float64(42),
"author_email": "", "expectedHeadSha": "head-sha",
},
expectedMergeResult: mockMergeResult,
},
{
name: "merge fails",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
Expand Down
Loading