chore: documentation update (#99)

* bug: exception handling in asynchronous MCP tools

Closes: #92

* chore: consistent variable names

* chore: update documentation

Author: saidsef

README.md

@@ -38,7 +38,7 @@ The toolset enables automated PR analysis, issue tracking, tagging and release m
                                      |                        |
                                      +------------------------+
                                               |
-                                              | (stdio/MCP_ENABLE_REMOTE)
+                                              | (stdio/SSE)
                                               v
 +--------------------+              +------------------------+
 |                    |              |    PRIssueAnalyser     |
@@ -73,7 +73,7 @@ The toolset enables automated PR analysis, issue tracking, tagging and release m
 - PRIssueAnalyser: Main MCP server handling tool registration and requests
 - GitHub Integration: Manages all GitHub API interactions
 - IP Integration: Handles IPv4/IPv6 information retrieval
-- MCP Client: Interacts via stdio or Server-Sent Events (MCP_ENABLE_REMOTE)
+- MCP Client: Interacts via stdio or Server-Sent Events (SSE)
 
 ## Local Installation
 

src/mcp_github/issues_pr_analyser.py

@@ -32,7 +32,7 @@
 
 class PRIssueAnalyser:
     """
-    PRIssueAnalyser is a class that provides an interface for analyzing GitHub Pull Requests (PRs) and managing GitHub Issues, Tags, and Releases, as well as retrieving IP information. It integrates with GitHub and an MCP (Multi-Component Platform) server to expose a set of tools for PR and issue management, and can be run as an MCP server using either MCP_ENABLE_REMOTE or stdio transport.
+    PRIssueAnalyser is a class that provides an interface for analyzing GitHub Pull Requests (PRs) and managing GitHub Issues, Tags, and Releases, as well as retrieving IP information. It integrates with GitHub and an MCP (Multi-Component Platform) server to expose a set of tools for PR and issue management, and can be run as an MCP server using either SSE or stdio transport.
     Methods
     -------
     __init__():
@@ -383,7 +383,7 @@ def run(self):
         """
         Runs the MCP Server for GitHub PR Analysis using the appropriate transport.
         This method checks the 'MCP_ENABLE_REMOTE' environment variable to determine whether to use
-        Server-Sent Events (MCP_ENABLE_REMOTE) or standard input/output (stdio) as the transport mechanism
+        Server-Sent Events (SSE) or standard input/output (stdio) as the transport mechanism
         for the MCP server. It logs the server startup and handles any exceptions that occur
         during execution, logging errors and printing the traceback to standard error.
         Returns: