fix: shorten long tool name for adding pr review comments (github#697)

LuluBeatson · web-flow · commit b5e33481793a · 2025-07-18T10:57:05.000+01:00
* shorten tool name

* update function name to match tool name

* adjust wording of descriptions
diff --git a/README.md b/README.md
@@ -589,7 +589,7 @@ The following sets of tools are available (all are on by default):
 
 <summary>Pull Requests</summary>
 
-- **add_pull_request_review_comment_to_pending_review** - Add comment to the requester's latest pending pull request review
+- **add_comment_to_pending_review** - Add review comment to the requester's latest pending pull request review
   - `body`: The text of the review comment (string, required)
   - `line`: The line of the blob in the pull request diff that the comment applies to. For multi-line comments, the last line of the range (number, optional)
   - `owner`: Repository owner (string, required)
diff --git a/e2e/e2e_test.go b/e2e/e2e_test.go
@@ -1338,7 +1338,7 @@ func TestPullRequestReviewCommentSubmit(t *testing.T) {
 
 	// Add a file review comment
 	addFileReviewCommentRequest := mcp.CallToolRequest{}
-	addFileReviewCommentRequest.Params.Name = "add_pull_request_review_comment_to_pending_review"
+	addFileReviewCommentRequest.Params.Name = "add_comment_to_pending_review"
 	addFileReviewCommentRequest.Params.Arguments = map[string]any{
 		"owner":       currentOwner,
 		"repo":        repoName,
@@ -1350,12 +1350,12 @@ func TestPullRequestReviewCommentSubmit(t *testing.T) {
 
 	t.Logf("Adding file review comment to pull request in %s/%s...", currentOwner, repoName)
 	resp, err = mcpClient.CallTool(ctx, addFileReviewCommentRequest)
-	require.NoError(t, err, "expected to call 'add_pull_request_review_comment_to_pending_review' tool successfully")
+	require.NoError(t, err, "expected to call 'add_comment_to_pending_review' tool successfully")
 	require.False(t, resp.IsError, fmt.Sprintf("expected result not to be an error: %+v", resp))
 
 	// Add a single line review comment
 	addSingleLineReviewCommentRequest := mcp.CallToolRequest{}
-	addSingleLineReviewCommentRequest.Params.Name = "add_pull_request_review_comment_to_pending_review"
+	addSingleLineReviewCommentRequest.Params.Name = "add_comment_to_pending_review"
 	addSingleLineReviewCommentRequest.Params.Arguments = map[string]any{
 		"owner":       currentOwner,
 		"repo":        repoName,
@@ -1370,12 +1370,12 @@ func TestPullRequestReviewCommentSubmit(t *testing.T) {
 
 	t.Logf("Adding single line review comment to pull request in %s/%s...", currentOwner, repoName)
 	resp, err = mcpClient.CallTool(ctx, addSingleLineReviewCommentRequest)
-	require.NoError(t, err, "expected to call 'add_pull_request_review_comment_to_pending_review' tool successfully")
+	require.NoError(t, err, "expected to call 'add_comment_to_pending_review' tool successfully")
 	require.False(t, resp.IsError, fmt.Sprintf("expected result not to be an error: %+v", resp))
 
 	// Add a multiline review comment
 	addMultilineReviewCommentRequest := mcp.CallToolRequest{}
-	addMultilineReviewCommentRequest.Params.Name = "add_pull_request_review_comment_to_pending_review"
+	addMultilineReviewCommentRequest.Params.Name = "add_comment_to_pending_review"
 	addMultilineReviewCommentRequest.Params.Arguments = map[string]any{
 		"owner":       currentOwner,
 		"repo":        repoName,
@@ -1392,7 +1392,7 @@ func TestPullRequestReviewCommentSubmit(t *testing.T) {
 
 	t.Logf("Adding multi line review comment to pull request in %s/%s...", currentOwner, repoName)
 	resp, err = mcpClient.CallTool(ctx, addMultilineReviewCommentRequest)
-	require.NoError(t, err, "expected to call 'add_pull_request_review_comment_to_pending_review' tool successfully")
+	require.NoError(t, err, "expected to call 'add_comment_to_pending_review' tool successfully")
 	require.False(t, resp.IsError, fmt.Sprintf("expected result not to be an error: %+v", resp))
 
 	// Submit the review
diff --git a/pkg/github/__toolsnaps__/add_comment_to_pending_review.snap b/pkg/github/__toolsnaps__/add_comment_to_pending_review.snap
@@ -1,9 +1,9 @@
 {
   "annotations": {
-    "title": "Add comment to the requester's latest pending pull request review",
+    "title": "Add review comment to the requester's latest pending pull request review",
     "readOnlyHint": false
   },
-  "description": "Add a comment to the requester's latest pending pull request review, a pending review needs to already exist to call this (check with the user if not sure).",
+  "description": "Add review comment to the requester's latest pending pull request review. A pending review needs to already exist to call this (check with the user if not sure).",
   "inputSchema": {
     "properties": {
       "body": {
@@ -69,5 +69,5 @@
     ],
     "type": "object"
   },
-  "name": "add_pull_request_review_comment_to_pending_review"
+  "name": "add_comment_to_pending_review"
 }
diff --git a/pkg/github/pullrequests.go b/pkg/github/pullrequests.go
@@ -1151,12 +1151,12 @@ func CreatePendingPullRequestReview(getGQLClient GetGQLClientFn, t translations.
 		}
 }
 
-// AddPullRequestReviewCommentToPendingReview creates a tool to add a comment to a pull request review.
-func AddPullRequestReviewCommentToPendingReview(getGQLClient GetGQLClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc) {
-	return mcp.NewTool("add_pull_request_review_comment_to_pending_review",
-			mcp.WithDescription(t("TOOL_ADD_PULL_REQUEST_REVIEW_COMMENT_TO_PENDING_REVIEW_DESCRIPTION", "Add a comment to the requester's latest pending pull request review, a pending review needs to already exist to call this (check with the user if not sure).")),
+// AddCommentToPendingReview creates a tool to add a comment to a pull request review.
+func AddCommentToPendingReview(getGQLClient GetGQLClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc) {
+	return mcp.NewTool("add_comment_to_pending_review",
+			mcp.WithDescription(t("TOOL_ADD_COMMENT_TO_PENDING_REVIEW_DESCRIPTION", "Add review comment to the requester's latest pending pull request review. A pending review needs to already exist to call this (check with the user if not sure).")),
 			mcp.WithToolAnnotation(mcp.ToolAnnotation{
-				Title:        t("TOOL_ADD_PULL_REQUEST_REVIEW_COMMENT_TO_PENDING_REVIEW_USER_TITLE", "Add comment to the requester's latest pending pull request review"),
+				Title:        t("TOOL_ADD_COMMENT_TO_PENDING_REVIEW_USER_TITLE", "Add review comment to the requester's latest pending pull request review"),
 				ReadOnlyHint: ToBoolPtr(false),
 			}),
 			// Ideally, for performance sake this would just accept the pullRequestReviewID. However, we would need to
diff --git a/pkg/github/pullrequests_test.go b/pkg/github/pullrequests_test.go
@@ -2137,10 +2137,10 @@ func TestAddPullRequestReviewCommentToPendingReview(t *testing.T) {
 
 	// Verify tool definition once
 	mockClient := githubv4.NewClient(nil)
-	tool, _ := AddPullRequestReviewCommentToPendingReview(stubGetGQLClientFn(mockClient), translations.NullTranslationHelper)
+	tool, _ := AddCommentToPendingReview(stubGetGQLClientFn(mockClient), translations.NullTranslationHelper)
 	require.NoError(t, toolsnaps.Test(tool.Name, tool))
 
-	assert.Equal(t, "add_pull_request_review_comment_to_pending_review", tool.Name)
+	assert.Equal(t, "add_comment_to_pending_review", tool.Name)
 	assert.NotEmpty(t, tool.Description)
 	assert.Contains(t, tool.InputSchema.Properties, "owner")
 	assert.Contains(t, tool.InputSchema.Properties, "repo")
@@ -2222,7 +2222,7 @@ func TestAddPullRequestReviewCommentToPendingReview(t *testing.T) {
 
 			// Setup client with mock
 			client := githubv4.NewClient(tc.mockedClient)
-			_, handler := AddPullRequestReviewCommentToPendingReview(stubGetGQLClientFn(client), translations.NullTranslationHelper)
+			_, handler := AddCommentToPendingReview(stubGetGQLClientFn(client), translations.NullTranslationHelper)
 
 			// Create call request
 			request := createMCPRequest(tc.requestArgs)
diff --git a/pkg/github/tools.go b/pkg/github/tools.go
@@ -89,7 +89,7 @@ func DefaultToolsetGroup(readOnly bool, getClient GetClientFn, getGQLClient GetG
 			// Reviews
 			toolsets.NewServerTool(CreateAndSubmitPullRequestReview(getGQLClient, t)),
 			toolsets.NewServerTool(CreatePendingPullRequestReview(getGQLClient, t)),
-			toolsets.NewServerTool(AddPullRequestReviewCommentToPendingReview(getGQLClient, t)),
+			toolsets.NewServerTool(AddCommentToPendingReview(getGQLClient, t)),
 			toolsets.NewServerTool(SubmitPendingPullRequestReview(getGQLClient, t)),
 			toolsets.NewServerTool(DeletePendingPullRequestReview(getGQLClient, t)),
 		)

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ func DefaultToolsetGroup(readOnly bool, getClient GetClientFn, getGQLClient GetG`
`89`	`89`	`// Reviews`
`90`	`90`	`toolsets.NewServerTool(CreateAndSubmitPullRequestReview(getGQLClient, t)),`
`91`	`91`	`toolsets.NewServerTool(CreatePendingPullRequestReview(getGQLClient, t)),`
`92`		`- toolsets.NewServerTool(AddPullRequestReviewCommentToPendingReview(getGQLClient, t)),`
	`92`	`+ toolsets.NewServerTool(AddCommentToPendingReview(getGQLClient, t)),`
`93`	`93`	`toolsets.NewServerTool(SubmitPendingPullRequestReview(getGQLClient, t)),`
`94`	`94`	`toolsets.NewServerTool(DeletePendingPullRequestReview(getGQLClient, t)),`
`95`	`95`	`)`