Add line parameter support to create_pull_request_review tool

ashwin-ant · claude · ashwin-ant · commit 6fd0bb9d98cf · 2025-04-04T19:19:16.000-07:00
- Updated schema to make path and body the only required fields - Added line parameter as alternative to position for inline comments - Updated handler to accept either position or line based on GitHub API spec - Added new test case that verifies line parameter works properly - Updated error messages for better validation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
diff --git a/README.md b/README.md
@@ -266,7 +266,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
   - `body`: Review comment text (string, optional)
   - `event`: Review action ('APPROVE', 'REQUEST_CHANGES', 'COMMENT') (string, required)
   - `commitId`: SHA of commit to review (string, optional)
-  - `comments`: Line-specific comments array of objects, each object with path (string), position (number), and body (string) (array, optional)
+  - `comments`: Line-specific comments array of objects, each object with path (string), either position (number) or line (number), and body (string) (array, optional)
 
 - **create_pull_request** - Create a new pull request
 
diff --git a/pkg/github/pullrequests.go b/pkg/github/pullrequests.go
@@ -593,15 +593,19 @@ func createPullRequestReview(client *github.Client, t translations.TranslationHe
 					map[string]interface{}{
 						"type":                 "object",
 						"additionalProperties": false,
-						"required":             []string{"path", "position", "body"},
+						"required":             []string{"path", "body"},
 						"properties": map[string]interface{}{
 							"path": map[string]interface{}{
 								"type":        "string",
 								"description": "path to the file",
 							},
 							"position": map[string]interface{}{
 								"type":        "number",
-								"description": "line number in the file",
+								"description": "position of the comment in the diff",
+							},
+							"line": map[string]interface{}{
+								"type":        "number",
+								"description": "line number in the file to comment on (alternative to position)",
 							},
 							"body": map[string]interface{}{
 								"type":        "string",
@@ -610,7 +614,7 @@ func createPullRequestReview(client *github.Client, t translations.TranslationHe
 						},
 					},
 				),
-				mcp.Description("Line-specific comments array of objects, each object with path (string), position (number), and body (string)"),
+				mcp.Description("Line-specific comments array of objects, each object with path (string), either position (number) or line (number), and body (string)"),
 			),
 		),
 		func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
@@ -661,30 +665,40 @@ func createPullRequestReview(client *github.Client, t translations.TranslationHe
 				for _, c := range commentsObj {
 					commentMap, ok := c.(map[string]interface{})
 					if !ok {
-						return mcp.NewToolResultError("each comment must be an object with path, position, and body"), nil
+						return mcp.NewToolResultError("each comment must be an object with path and body"), nil
 					}
 
 					path, ok := commentMap["path"].(string)
 					if !ok || path == "" {
 						return mcp.NewToolResultError("each comment must have a path"), nil
 					}
 
-					positionFloat, ok := commentMap["position"].(float64)
-					if !ok {
-						return mcp.NewToolResultError("each comment must have a position"), nil
-					}
-					position := int(positionFloat)
-
 					body, ok := commentMap["body"].(string)
 					if !ok || body == "" {
 						return mcp.NewToolResultError("each comment must have a body"), nil
 					}
 
-					comments = append(comments, &github.DraftReviewComment{
-						Path:     github.Ptr(path),
-						Position: github.Ptr(position),
-						Body:     github.Ptr(body),
-					})
+					comment := &github.DraftReviewComment{
+						Path: github.Ptr(path),
+						Body: github.Ptr(body),
+					}
+
+					// Check if position is provided
+					if positionFloat, ok := commentMap["position"].(float64); ok {
+						comment.Position = github.Ptr(int(positionFloat))
+					}
+
+					// Check if line is provided
+					if lineFloat, ok := commentMap["line"].(float64); ok {
+						comment.Line = github.Ptr(int(lineFloat))
+					}
+
+					// Ensure one of position or line is provided
+					if comment.Position == nil && comment.Line == nil {
+						return mcp.NewToolResultError("each comment must have either position or line"), nil
+					}
+
+					comments = append(comments, comment)
 				}
 
 				reviewRequest.Comments = comments
diff --git a/pkg/github/pullrequests_test.go b/pkg/github/pullrequests_test.go
@@ -1167,7 +1167,44 @@ func Test_CreatePullRequestReview(t *testing.T) {
 				},
 			},
 			expectError:    false,
-			expectedErrMsg: "each comment must have a position",
+			expectedErrMsg: "each comment must have either position or line",
+		},
+		{
+			name: "successful review creation with line parameter",
+			mockedClient: mock.NewMockedHTTPClient(
+				mock.WithRequestMatchHandler(
+					mock.PostReposPullsReviewsByOwnerByRepoByPullNumber,
+					expectRequestBody(t, map[string]interface{}{
+						"body":  "Code review comments",
+						"event": "COMMENT",
+						"comments": []interface{}{
+							map[string]interface{}{
+								"path": "main.go",
+								"line": float64(42),
+								"body": "Consider adding a comment here",
+							},
+						},
+					}).andThen(
+						mockResponse(t, http.StatusOK, mockReview),
+					),
+				),
+			),
+			requestArgs: map[string]interface{}{
+				"owner":      "owner",
+				"repo":       "repo",
+				"pullNumber": float64(42),
+				"body":       "Code review comments",
+				"event":      "COMMENT",
+				"comments": []interface{}{
+					map[string]interface{}{
+						"path": "main.go",
+						"line": float64(42),
+						"body": "Consider adding a comment here",
+					},
+				},
+			},
+			expectError:    false,
+			expectedReview: mockReview,
 		},
 		{
 			name: "review creation fails",
