Skip to content

Commit 46f9a99

Browse files
CAOShurongCAOShurong
committed
feat(issues): add batch_update_issue_labels granular tool
Add a feature-flagged batch labeling tool that applies add/remove label operations to multiple issues in a single MCP call, avoiding N sequential update_issue_labels round-trips for bulk triage workflows (e.g. 'label all issues from milestone X as priority/high'). - Each operation entry targets one issue with add and/or remove arrays; labels not named in the operation are left untouched. - All input is validated before any mutation: empty operations, duplicate issue numbers, missing add/remove, and empty label names fail the whole call up front. Per-issue API errors are reported individually in the JSON result with applied/error per issue. - Add phase uses POST /issues/{n}/labels (additive) and returns the full resulting label set; remove phase uses DELETE per label. Closes #2412
1 parent febc329 commit 46f9a99

6 files changed

Lines changed: 435 additions & 0 deletions

File tree

‎pkg/github/__toolsnaps__/batch_update_issue_labels.snap‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"annotations": {
3+
"destructiveHint": false,
4+
"idempotentHint": false,
5+
"openWorldHint": true,
6+
"readOnlyHint": false,
7+
"title": "Batch Update Issue Labels"
8+
},
9+
"description": "Apply label changes to multiple issues in one call. Each entry in operations targets one issue and can add labels, remove labels, or both. Labels not named in the operation are left untouched. Invalid input fails the whole call before any change is applied; per-issue API errors are reported individually.",
10+
"inputSchema": {
11+
"properties": {
12+
"operations": {
13+
"description": "One entry per issue, in any order. Each entry requires issue_number plus at least one non-empty of add or remove (arrays of label names). Duplicate issue numbers are rejected.",
14+
"items": {
15+
"additionalProperties": false,
16+
"properties": {
17+
"add": {
18+
"description": "Label names to add to this issue (GitHub creates missing labels implicitly)",
19+
"items": {
20+
"minLength": 1,
21+
"type": "string"
22+
},
23+
"type": "array"
24+
},
25+
"issue_number": {
26+
"description": "The issue number to update",
27+
"minimum": 1,
28+
"type": "number"
29+
},
30+
"remove": {
31+
"description": "Label names to remove from this issue",
32+
"items": {
33+
"minLength": 1,
34+
"type": "string"
35+
},
36+
"type": "array"
37+
}
38+
},
39+
"required": [
40+
"issue_number"
41+
],
42+
"type": "object"
43+
},
44+
"minItems": 1,
45+
"type": "array"
46+
},
47+
"owner": {
48+
"description": "Repository owner (username or organization)",
49+
"type": "string"
50+
},
51+
"repo": {
52+
"description": "Repository name",
53+
"type": "string"
54+
}
55+
},
56+
"required": [
57+
"owner",
58+
"repo",
59+
"operations"
60+
],
61+
"type": "object"
62+
},
63+
"name": "batch_update_issue_labels"
64+
}

‎pkg/github/batch_labels_granular_test.go‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
package github
2+
3+
import (
4+
"context"
5+
"net/http"
6+
"strings"
7+
"testing"
8+
9+
"github.com/github/github-mcp-server/pkg/translations"
10+
gogithub "github.com/google/go-github/v89/github"
11+
"github.com/stretchr/testify/assert"
12+
"github.com/stretchr/testify/require"
13+
)
14+
15+
func TestGranularBatchUpdateIssueLabels(t *testing.T) {
16+
tests := []struct {
17+
name string
18+
mockedClient *http.Client
19+
requestArgs map[string]any
20+
expectToolErr bool
21+
expectedErrMsg string
22+
}{
23+
{
24+
name: "add and remove across multiple issues",
25+
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
26+
PostReposIssuesByOwnerByRepoByIssueNumberLabels: expectRequestBody(t, []any{"bug", "priority/high"}).
27+
andThen(mockResponse(t, http.StatusOK, []*gogithub.Label{
28+
{Name: "bug"},
29+
{Name: "priority/high"},
30+
})),
31+
DeleteReposIssuesByOwnerByRepoByIssueNumberLabel: mockResponse(t, http.StatusNoContent, nil),
32+
}),
33+
requestArgs: map[string]any{
34+
"owner": "owner",
35+
"repo": "repo",
36+
"operations": []any{
37+
map[string]any{
38+
"issue_number": float64(1),
39+
"add": []any{"bug", "priority/high"},
40+
},
41+
map[string]any{
42+
"issue_number": float64(2),
43+
"remove": []any{"wontfix"},
44+
},
45+
},
46+
},
47+
expectToolErr: false,
48+
},
49+
{
50+
name: "empty operations array rejected",
51+
mockedClient: MockHTTPClientWithHandlers(nil),
52+
requestArgs: map[string]any{
53+
"owner": "owner",
54+
"repo": "repo",
55+
"operations": []any{},
56+
},
57+
expectToolErr: true,
58+
expectedErrMsg: "operations must contain at least one entry",
59+
},
60+
{
61+
name: "missing operations parameter rejected",
62+
mockedClient: MockHTTPClientWithHandlers(nil),
63+
requestArgs: map[string]any{
64+
"owner": "owner",
65+
"repo": "repo",
66+
},
67+
expectToolErr: true,
68+
expectedErrMsg: "missing required parameter: operations",
69+
},
70+
{
71+
name: "operation without add or remove rejected",
72+
mockedClient: MockHTTPClientWithHandlers(nil),
73+
requestArgs: map[string]any{
74+
"owner": "owner",
75+
"repo": "repo",
76+
"operations": []any{
77+
map[string]any{"issue_number": float64(1)},
78+
},
79+
},
80+
expectToolErr: true,
81+
expectedErrMsg: "at least one non-empty of add or remove is required",
82+
},
83+
{
84+
name: "duplicate issue numbers rejected",
85+
mockedClient: MockHTTPClientWithHandlers(nil),
86+
requestArgs: map[string]any{
87+
"owner": "owner",
88+
"repo": "repo",
89+
"operations": []any{
90+
map[string]any{"issue_number": float64(1), "add": []any{"bug"}},
91+
map[string]any{"issue_number": float64(1), "remove": []any{"wontfix"}},
92+
},
93+
},
94+
expectToolErr: true,
95+
expectedErrMsg: "duplicate issue_number 1",
96+
},
97+
{
98+
name: "empty label name in add rejected",
99+
mockedClient: MockHTTPClientWithHandlers(nil),
100+
requestArgs: map[string]any{
101+
"owner": "owner",
102+
"repo": "repo",
103+
"operations": []any{
104+
map[string]any{"issue_number": float64(1), "add": []any{""}},
105+
},
106+
},
107+
expectToolErr: true,
108+
expectedErrMsg: "add contains an empty label name",
109+
},
110+
}
111+
112+
for _, tc := range tests {
113+
t.Run(tc.name, func(t *testing.T) {
114+
deps := BaseDeps{Client: mustNewGHClient(t, tc.mockedClient)}
115+
serverTool := GranularBatchUpdateIssueLabels(translations.NullTranslationHelper)
116+
handler := serverTool.Handler(deps)
117+
118+
request := createMCPRequest(tc.requestArgs)
119+
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
120+
require.NoError(t, err)
121+
if tc.expectToolErr {
122+
errorContent := getErrorResult(t, result)
123+
assert.Contains(t, errorContent.Text, tc.expectedErrMsg)
124+
return
125+
}
126+
assert.False(t, result.IsError)
127+
textContent := getTextResult(t, result)
128+
assert.Contains(t, textContent.Text, `"issue_number":1`)
129+
assert.Contains(t, textContent.Text, `"applied":true`)
130+
})
131+
}
132+
}
133+
134+
func TestGranularBatchUpdateIssueLabelsPartialFailure(t *testing.T) {
135+
client := mustNewGHClient(t, MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
136+
PostReposIssuesByOwnerByRepoByIssueNumberLabels: func(_ http.ResponseWriter, _ *http.Request) {},
137+
}))
138+
deps := BaseDeps{Client: client}
139+
serverTool := GranularBatchUpdateIssueLabels(translations.NullTranslationHelper)
140+
handler := serverTool.Handler(deps)
141+
142+
request := createMCPRequest(map[string]any{
143+
"owner": "owner",
144+
"repo": "repo",
145+
"operations": []any{
146+
map[string]any{"issue_number": float64(1), "add": []any{"bug"}},
147+
},
148+
})
149+
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
150+
require.NoError(t, err)
151+
// A per-issue API failure must surface as a tool error with a JSON body
152+
// identifying the failing issue.
153+
assert.True(t, result.IsError, "expected IsError on API failure")
154+
textContent := getTextResult(t, result)
155+
assert.True(t, strings.Contains(textContent.Text, "add failed"))
156+
}

‎pkg/github/granular_tools_test.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ func TestGranularToolSnaps(t *testing.T) {
3838
GranularUpdateIssueBody,
3939
GranularUpdateIssueAssignees,
4040
GranularUpdateIssueLabels,
41+
GranularBatchUpdateIssueLabels,
4142
GranularUpdateIssueMilestone,
4243
GranularUpdateIssueType,
4344
GranularUpdateIssueState,
@@ -84,6 +85,7 @@ func TestIssuesGranularToolset(t *testing.T) {
8485
"update_issue_body",
8586
"update_issue_assignees",
8687
"update_issue_labels",
88+
"batch_update_issue_labels",
8789
"update_issue_milestone",
8890
"update_issue_type",
8991
"update_issue_state",

‎pkg/github/helper_test.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ const (
6464
GetReposIssuesCommentsByOwnerByRepoByIssueNumber = "GET /repos/{owner}/{repo}/issues/{issue_number}/comments"
6565
PostReposIssuesByOwnerByRepo = "POST /repos/{owner}/{repo}/issues"
6666
PostReposIssuesCommentsByOwnerByRepoByIssueNumber = "POST /repos/{owner}/{repo}/issues/{issue_number}/comments"
67+
PostReposIssuesByOwnerByRepoByIssueNumberLabels = "POST /repos/{owner}/{repo}/issues/{issue_number}/labels"
68+
DeleteReposIssuesByOwnerByRepoByIssueNumberLabel = "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}"
6769
PostReposIssuesReactionsByOwnerByRepoByIssueNumber = "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions"
6870
PatchReposIssuesByOwnerByRepoByIssueNumber = "PATCH /repos/{owner}/{repo}/issues/{issue_number}"
6971
GetReposIssuesSubIssuesByOwnerByRepoByIssueNumber = "GET /repos/{owner}/{repo}/issues/{issue_number}/sub_issues"

0 commit comments

Comments
 (0)