Skip to main content

codebolt.reviewMergeRequest

Review merge request tools for creating, listing, and merging code review requests. Note: This is different from review.md which covers code review workflow tools.

Available Tools

  • reviewMergeRequest_create - Creates a new review merge request with branches and description
  • reviewMergeRequest_list - Lists all review merge requests with optional filtering
  • reviewMergeRequest_merge - Merges a review merge request after approval

Tool Parameters

reviewMergeRequest_create

Creates a new review merge request for code review workflow.

ParameterTypeRequiredDescription
titlestringYesThe title of the review merge request
descriptionstringYesDetailed description of the changes being proposed
sourceBranchstringYesThe name of the source branch containing the changes
targetBranchstringYesThe name of the target branch to merge into (e.g., main, develop)
authorIdstringYesThe ID of the author creating the merge request
swarmIdstringNoOptional swarm ID for grouping related requests
explanationstringNoOptional explanation or context for the merge request

reviewMergeRequest_list

Lists all review merge requests with optional filtering capabilities.

ParameterTypeRequiredDescription
statusstringNoFilter requests by status (e.g., pending, approved, merged, rejected)
authorIdstringNoFilter requests by author ID
swarmIdstringNoFilter requests by swarm ID
limitnumberNoMaximum number of requests to return
explanationstringNoOptional explanation for the list request

reviewMergeRequest_merge

Merges an existing review merge request after it has been approved.

ParameterTypeRequiredDescription
idstringYesThe unique ID of the review merge request to merge
mergedBystringYesThe ID of the user performing the merge operation
explanationstringNoOptional explanation or notes about the merge

Sample Usage

// Create a new review merge request
await codebolt.reviewMergeRequest_create({
title: "Add user authentication feature",
description: "Implement OAuth2 login with Google and GitHub providers",
sourceBranch: "feature/user-auth",
targetBranch: "main",
authorId: "user-123"
});

// Create with optional swarm ID
await codebolt.reviewMergeRequest_create({
title: "Fix memory leak in data processor",
description: "Resolved issue where large datasets caused memory overflow",
sourceBranch: "bugfix/memory-leak",
targetBranch: "develop",
authorId: "user-456",
swarmId: "swarm-789"
});

// List all pending review merge requests
await codebolt.reviewMergeRequest_list({
status: "pending",
limit: 10
});

// List requests by author
await codebolt.reviewMergeRequest_list({
authorId: "user-123",
status: "approved"
});

// Merge an approved review request
await codebolt.reviewMergeRequest_merge({
id: "rmr-abc-123",
mergedBy: "user-789"
});
info

Important Notes:

  • Review merge requests follow a lifecycle: pending → approved → merged (or rejected)
  • The sourceBranch and targetBranch parameters must match existing branch names in your repository
  • Only approved review merge requests can be merged successfully
  • Merge requests with swarmId are typically grouped for batch processing or related features
  • The authorId and mergedBy fields are used for audit trail and permission checking