create_pull_request
Create GitHub pull requests with automated authentication handling to streamline code review workflows. Specify title, description, branches, and preview changes before submission.
Instructions
Create a GitHub pull request with proper authentication handling
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | Pull request title | |
| body | Yes | Pull request description | |
| baseBranch | No | Base branch (target) | main |
| headBranch | No | Head branch (source, defaults to current branch) | |
| workingDir | No | Working directory path | |
| dryRun | No | Preview without executing |
Implementation Reference
- src/index.ts:236-292 (handler)The core handler function implementing the create_pull_request tool logic. Uses GitHub CLI (gh pr create) with authentication handling via token clearing and PowerShell escaping.async function createPullRequest( title: string, body: string, baseBranch: string = 'main', headBranch?: string, workingDir?: string, dryRun: boolean = false ): Promise<WorkflowResult> { try { if (dryRun) { return { success: true, message: "Dry run: Would create pull request", details: { title, body, baseBranch, headBranch } }; } // Get current branch if not specified if (!headBranch) { const git = getGit(workingDir); headBranch = await git.revparse(['--abbrev-ref', 'HEAD']); } // Create PR using GitHub CLI with cleared tokens and proper escaping const command = `gh pr create --title "${title}" --body "${body}" --base ${baseBranch} --head ${headBranch}`; const result = await executeGitHubCommand(command, { title, body, cwd: workingDir }); // Extract PR URL from output const prUrl = result.stdout.trim(); return { success: true, message: "Successfully created pull request", details: { url: prUrl, title, baseBranch, headBranch } }; } catch (error: any) { return { success: false, message: "Failed to create pull request", error: `Failed to create pull request: ${error.message}` }; } }
- src/index.ts:452-486 (registration)Tool registration in ListToolsRequestSchema handler, including name, description, and input schema definition.name: "create_pull_request", description: "Create a GitHub pull request with proper authentication handling", inputSchema: { type: "object", properties: { title: { type: "string", description: "Pull request title" }, body: { type: "string", description: "Pull request description" }, baseBranch: { type: "string", description: "Base branch (target)", default: "main" }, headBranch: { type: "string", description: "Head branch (source, defaults to current branch)" }, workingDir: { type: "string", description: "Working directory path" }, dryRun: { type: "boolean", description: "Preview without executing", default: false } }, required: ["title", "body"] } },
- src/index.ts:595-604 (registration)Dispatch logic in CallToolRequestSchema handler that routes to the createPullRequest function.case "create_pull_request": result = await createPullRequest( args?.title as string, args?.body as string, (args?.baseBranch as string) || 'main', args?.headBranch as string, args?.workingDir as string, (args?.dryRun as boolean) || false ); break;
- src/index.ts:65-115 (helper)Supporting helper function for safely executing GitHub CLI commands with environment token clearing and PowerShell string escaping, crucial for the PR creation.async function executeGitHubCommand( baseCommand: string, options?: { title?: string; body?: string; cwd?: string; } ): Promise<{ stdout: string; stderr: string }> { let tempBodyFile: string | null = null; try { let finalCommand = baseCommand; // If we have a body, write it to a temporary file to avoid PowerShell parsing issues if (options?.body) { tempBodyFile = join(tmpdir(), `gh-pr-body-${Date.now()}.txt`); writeFileSync(tempBodyFile, options.body, 'utf8'); // Replace --body with --body-file, handling both quoted and unquoted body content finalCommand = finalCommand.replace(/--body\s+"[^"]*"/, `--body-file "${tempBodyFile}"`); finalCommand = finalCommand.replace(/--body\s+[^\s]+/, `--body-file "${tempBodyFile}"`); } // If we have a title, properly escape it for PowerShell if (options?.title) { const escapedTitle = escapePowerShellString(options.title); finalCommand = finalCommand.replace(/--title\s+"([^"]*)"/, `--title '${escapedTitle}'`); } // Build the PowerShell command with proper token clearing const powerShellCommand = `powershell -Command "Remove-Item Env:GH_TOKEN -ErrorAction SilentlyContinue; Remove-Item Env:GITHUB_TOKEN -ErrorAction SilentlyContinue; ${finalCommand}"`; const result = await execAsync(powerShellCommand, { cwd: options?.cwd || process.cwd(), maxBuffer: 1024 * 1024 // 1MB buffer }); return result; } catch (error: any) { throw new Error(`Command failed: ${error.message}\nStdout: ${error.stdout}\nStderr: ${error.stderr}`); } finally { // Clean up temporary file if (tempBodyFile) { try { unlinkSync(tempBodyFile); } catch (e) { // Ignore cleanup errors } } } }