create_pr
Create a new pull request in a GitHub repository by specifying branches, title, and description to propose code changes for review.
Instructions
Creates a new pull request in the specified GitHub repository. Args: repo_owner (str): The owner of the repository. repo_name (str): The name of the repository. title (str): The title of the pull request. body (str): The body content of the pull request. head (str): The name of the branch where your changes are implemented. base (str): The name of the branch you want the changes pulled into. draft (bool, optional): Whether the pull request is a draft. Defaults to False. Returns: Dict[str, Any]: The JSON response from the GitHub API containing pull request information if successful. Error Handling: Logs errors and prints the traceback if the pull request creation fails, returning None.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| repo_owner | Yes | ||
| repo_name | Yes | ||
| title | Yes | ||
| body | Yes | ||
| head | Yes | ||
| base | Yes | ||
| draft | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- The handler function that implements the logic for creating a GitHub pull request (PR) using the GitHub REST API. It constructs the API request, sends it with authentication, and returns the PR details or error information.
def create_pr(self, repo_owner: str, repo_name: str, title: str, body: str, head: str, base: str, draft: bool = False) -> Dict[str, Any]: """ Creates a new pull request in the specified GitHub repository. Args: repo_owner (str): The owner of the repository. repo_name (str): The name of the repository. title (str): The title of the pull request. body (str): The body content of the pull request. head (str): The name of the branch where your changes are implemented. base (str): The name of the branch you want the changes pulled into. draft (bool, optional): Whether the pull request is a draft. Defaults to False. Returns: Dict[str, Any]: The JSON response from the GitHub API containing pull request information if successful. Error Handling: Logs errors and prints the traceback if the pull request creation fails, returning None. """ logging.info(f"Creating PR in {repo_owner}/{repo_name}") pr_url = f"https://api.github.com/repos/{repo_owner}/{repo_name}/pulls" try: response = requests.post(pr_url, headers=self._get_headers(), json={ 'title': title, 'body': body, 'head': head, 'base': base, 'draft': draft }, timeout=TIMEOUT) response.raise_for_status() pr_data = response.json() logging.info("PR created successfully") return { "pr_url": pr_data.get('html_url'), "pr_number": pr_data.get('number'), "status": pr_data.get('state'), "title": pr_data.get('title'), } except Exception as e: logging.error(f"Error creating PR: {str(e)}") traceback.print_exc() return {"status": "error", "message": str(e)} - src/mcp_github/issues_pr_analyser.py:109-113 (registration)Dynamic registration of all public methods (non-private, i.e., not starting with '_') from the GitHubIntegration instance as MCP tools. This includes the create_pr method, registering it as the 'create_pr' tool.
def register_tools(self, methods: Any = None) -> None: for name, method in inspect.getmembers(methods): if (inspect.isfunction(method) or inspect.ismethod(method)) and not name.startswith("_"): self.mcp.add_tool(method) - src/mcp_github/issues_pr_analyser.py:105-108 (registration)Calls the register_tools method on the GitHubIntegration instance (self.gi), which triggers the registration of create_pr among other methods as MCP tools.
def _register_tools(self): self.register_tools(self.gi) self.register_tools(self.ip)