feat: enhance GitHub integration with inline PR comment support (#41)

* feat: Update GitHub integration

- Refactor GitHub API interaction module
- Add support for new GitHub event type
- Update documentation for GitHub integration setup

* fix: ci workflow

Author: saidsef

.github/workflows/ci.yml

@@ -4,14 +4,14 @@ on:
     branches:
       - main
     paths:
-      - "*.py"
+      - "src/mcp_github/*.py"
       - "Dockerfile"
       - ".github/workflows/ci.yml"
   pull_request:
     branches:
       - main
     paths:
-      - "*.py"
+      - "src/mcp_github/*.py"
       - "Dockerfile"
       - ".github/workflows/ci.yml"
   workflow_dispatch:
@@ -56,7 +56,7 @@ jobs:
         lfs: 'true'
     - name: Set Tag Name
       run: |
-        echo "TAG=$(echo ${{ github.head_ref || github.ref_name }})" >> $GITHUB_ENV
+        echo "TAG=$(echo ${{ github.head_ref || github.ref_name }} | sed 's/[^a-zA-Z0-9.-]/-/g')" >> $GITHUB_ENV
         echo "DATE=v$(echo `date +'%Y.%m'`)" >> $GITHUB_ENV
 
     - name: Run Trivy config vulnerability scanner

README.md

@@ -13,6 +13,8 @@ The toolset enables automated PR analysis, issue tracking, tagging and release m
 | PR Content Retrieval       | `get_github_pr_content`        | Fetch PR metadata including title, description, author, and state.                            |
 | PR Diff Analysis          | `get_github_pr_diff`           | Retrieve the diff/patch content showing file changes in the PR.                              |
 | PR Description Updates     | `update_github_pr_description` | Update PR titles and descriptions with What/Why/How sections and file changes.               |
+| PR General Comments        | `add_github_pr_comment`        | Add general discussion comments to pull requests.                                            |
+| PR Inline Code Comments    | `add_github_pr_inline_comment` | Add inline review comments to specific lines in PR files for code review.                    |
 | Issue Creation            | `create_github_issue`          | Create new issues with conventional commit prefixes (feat/fix/chore) and MCP label.          |
 | Issue Updates             | `update_github_issue`          | Modify existing issues with new title, body, and state (open/closed).                        |
 | Tag Management            | `create_github_tag`            | Create new git tags with associated messages for versioning.                                  |
@@ -80,11 +82,21 @@ cd mcp-github-pr-issue-analyser
 ```
 
 2. **Install dependencies:**
+
+Launch MCP in `stdio` mode.
 ```sh
-uv init
-uv venv
-uv pip install -r requirements.txt
+export GITHUB_TOKEN="<github-token>"
+uvx ./
 ```
+
+Alternatively, launch MCP in `sse` mode.
+```sh
+export GITHUB_TOKEN="<github-token>"
+export MCP_ENABLE_REMOTE=true
+uvx ./
+```
+> You can access it via `sse` i.e. `http(s)://localhost:8080/sse`
+
 ## Local Integration with Desktop LLMs
 
 To add an MCP server to your desktop LLM such as Claude etc.., you need to add this section to the configuration file. The basic structure involves defining a server name and providing the command and any necessary arguments to run the server.

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mcp-github-pr-issue-analyser"
-version = "2.1.0"
+version = "2.2.1"
 description = "MCP GitHub Issues Create/Update and PR Analyse"
 readme = "README.md"
 requires-python = ">=3.12"
@@ -27,5 +27,5 @@ testpaths = ["tests"]
 python_files = ["test_*.py"]
 
 [build-system]
-requires = ["setuptools>=61.0","wheel"]
+requires = ["setuptools>=61.0", "wheel"]
 build-backend = "setuptools.build_meta"

src/mcp_github/github_integration.py

@@ -184,6 +184,57 @@ def add_pr_comments(self, repo_owner: str, repo_name: str, pr_number: int, comme
             traceback.print_exc()
             return None
 
+    def add_inline_pr_comment(self, repo_owner: str, repo_name: str, pr_number: int, path: str, line: int, comment_body: str) -> Dict[str, Any]:
+        """
+        Adds an inline review comment to a specific line in a pull request file.
+
+        Args:
+            repo_owner (str): The owner of the repository.
+            repo_name (str): The name of the repository.
+            pr_number (int): The pull request number.
+            path (str): The relative path to the file (e.g., 'src/main.py').
+            line (int): The line number in the file to comment on.
+            comment_body (str): The content of the review comment.
+
+        Returns:
+            Dict[str, Any]: The JSON response from the GitHub API containing the comment data if successful.
+            None: If an error occurs while adding the comment.
+
+        Error Handling:
+            Logs an error message and prints the traceback if the request fails or an exception is raised.
+        """
+        logging.info(f"Adding inline review comment to PR {repo_owner}/{repo_name}#{pr_number} on {path}:{line}")
+
+        # Construct the review comments URL
+        review_comments_url = f"https://api.github.com/repos/{repo_owner}/{repo_name}/pulls/{pr_number}/comments"
+
+        try:
+            pr_url = self._get_pr_url(repo_owner, repo_name, pr_number)
+            pr_response = requests.get(pr_url, headers=self._get_headers())
+            pr_response.raise_for_status()
+            pr_data = pr_response.json()
+            commit_id = pr_data['head']['sha']
+
+            payload = {
+                "body": comment_body,
+                "commit_id": commit_id,
+                "path": path,
+                "line": line,
+                "side": "RIGHT"
+            }
+
+            response = requests.post(review_comments_url, headers=self._get_headers(), json=payload)
+            response.raise_for_status()
+            comment_data = response.json()
+
+            logging.info(f"Inline review comment added successfully")
+            return comment_data
+
+        except Exception as e:
+            logging.error(f"Error adding inline review comment: {str(e)}")
+            traceback.print_exc()
+            return None
+
     def update_pr_description(self, repo_owner: str, repo_name: str, pr_number: int, new_title: str, new_description: str) -> Dict[str, Any]:
         """
         Updates the title and description of a pull request on GitHub.

src/mcp_github/issues_pr_analyser.py

@@ -65,7 +65,10 @@ def __init__(self):
         self.ip = IP()
 
         # Initialize MCP Server
-        self.mcp = FastMCP("GitHub PR Analyse, Issue Create and Update")
+        self.mcp = FastMCP(
+            name="GitHub PR Analyse, Issue Create and Update",
+            instruction="Use the tools to analyze GitHub PRs, create and update issues, and manage tags and releases.",
+        )
         logging.info("MCP Server initialized")
 
         # Register MCP tools
@@ -107,8 +110,8 @@ async def get_github_pr_diff(repo_owner: str, repo_name: str, pr_number: int) ->
         @self.mcp.tool()
         async def get_github_pr_content(repo_owner: str, repo_name: str, pr_number: int) -> Dict[str, Any]:
             """
-            First use get_pr_diff to fetch the diff of a specific pull request from a GitHub repository.
-            Then, if you still need more context use get_pr_content to fetch the content of the pull request.
+            Use get_pr_diff to fetch the diff of a specific pull request from a GitHub repository.
+            If you still need more context, then use this to fetch the content of the pull request.
             Fetches the content of a GitHub pull request for a given repository and PR number.
             Args:
                 repo_owner (str): The owner of the GitHub repository.
@@ -161,6 +164,36 @@ async def update_github_pr_description(repo_owner: str, repo_name: str, pr_numbe
                 traceback.print_exc(file=sys.stderr)
                 return error_msg
 
+        @self.mcp.tool()
+        async def add_github_pr_inline_comment(repo_owner: str, repo_name: str, pr_number: int, path: str, line: int, comment_body: str) -> str:
+            """
+            Adds an inline review comment to a specific line in a GitHub pull request file.
+            Only comment if there is an issue with the code, otherwise do not comment.
+            Args:
+                repo_owner (str): The owner of the repository.
+                repo_name (str): The name of the repository.
+                pr_number (int): The pull request number to add the comment to.
+                path (str): The relative path to the file (e.g., 'src/main.py').
+                line (int): The line number in the file to comment on.
+                comment_body (str): The content of the review comment.
+
+            Returns:
+                str: A message indicating the result of the comment addition. Returns a success message if the comment is added successfully, or an error message if an exception occurs.
+
+            Error Handling:
+                Catches and logs any exceptions that occur during the comment addition process. If an error is encountered, the error message is logged and returned.
+            """
+            logging.info(f"Adding inline review comment to PR #{pr_number}")
+            try:
+                self.gi.add_inline_pr_comment(repo_owner, repo_name, pr_number, path, line, comment_body)
+                logging.info(f"Successfully added inline review comment to PR #{pr_number}")
+                return f"Successfully added inline review comment to PR #{pr_number}"
+            except Exception as e:
+                error_msg = f"Error adding inline review comment to PR: {str(e)}"
+                logging.error(error_msg)
+                traceback.print_exc(file=sys.stderr)
+                return error_msg
+
         @self.mcp.tool()
         async def add_github_pr_comment(repo_owner: str, repo_name: str, pr_number: int, comment: str) -> str:
             """
@@ -197,7 +230,7 @@ async def create_github_issue(repo_owner: str, repo_name: str, title: str, body:
             Args:
                 repo_owner (str): The owner of the GitHub repository.
                 repo_name (str): The name of the GitHub repository.
-                title (str): The title of the issue to be created.
+                title (str): The title of the issue to be created, one of chore, fix, bug, feat, docs etc.
                 body (str): The body content of the issue.
                 labels (list[str]): A list of labels to assign to the issue.
             Returns:
@@ -224,7 +257,7 @@ async def update_github_issue(repo_owner: str, repo_name: str, issue_number: int
                 repo_owner (str): The owner of the GitHub repository.
                 repo_name (str): The name of the GitHub repository.
                 issue_number (int): The number of the issue to update.
-                title (str): The new title for the issue.
+                title (str): The new title for the issue, one of chore, fix, bug, feat, docs etc.
                 body (str): The new body content for the issue.
                 labels (list[str]): A list of labels to assign to the issue.
                 state (str): The state to set for the issue (e.g., 'open', 'closed').
@@ -340,10 +373,10 @@ def run(self):
             Logs any exceptions that occur during server execution and prints the traceback
             to standard error for debugging purposes.
         """
-        MCP_ENABLE_SSE = getenv("ENABLE_SSE", None)
+        MCP_ENABLE_REMOTE = getenv("MCP_ENABLE_REMOTE", None)
         try:
             logging.info("Running MCP Server for GitHub PR Analysis.")
-            if MCP_ENABLE_SSE:
+            if MCP_ENABLE_REMOTE:
                 self.mcp.run(transport='sse')
             else:
                 self.mcp.run(transport='stdio')