Clarify tool descriptions

Author: almaleksia

README.md

@@ -580,10 +580,10 @@ The following sets of tools are available (all are on by default):
   - `issue_number`: The number of the issue (number, required)
   - `method`: The read operation to perform on a single issue. 
 Options are: 
-1. 'get' - get issue details
-2. 'get_comments' - get issue comments
-3. 'get_sub_issues' - list sub-issues of the issue
-4. 'get_labels' - list labels assigned to the issue
+1. get - Get details of a specific issue.
+2. get_comments - Get issue comments.
+3. get_sub_issues - Get sub-issues of the issue.
+4. get_labels - Get labels assigned to the issue.
  (string, required)
   - `owner`: The owner of the repository (string, required)
   - `page`: Page number for pagination (min 1) (number, optional)
@@ -836,8 +836,9 @@ Possible options:
  2. get_diff - Get the diff of a pull request.
  3. get_status - Get status of a head commit in a pull request. This reflects status of builds and checks.
  4. get_files - Get the list of files changed in a pull request. Use with pagination parameters to control the number of results returned.
- 5. get_review_comments - Get the review comments on a pull request. They are comments made on a portion of the unified diff during a pull request review. These are different from commit comments and issue comments in a pull request. Use with pagination parameters to control the number of results returned.
+ 5. get_review_comments - Get the review comments on a pull request. They are comments made on a portion of the unified diff during a pull request review. Use with pagination parameters to control the number of results returned.
  6. get_reviews - Get the reviews on a pull request. When asked for review comments, use get_review_comments method.
+ 7. get_comments - Get comments on a pull request. Use this if user doesn't specifically want review comments. Use with pagination parameters to control the number of results returned.
  (string, required)
   - `owner`: Repository owner (string, required)
   - `page`: Page number for pagination (min 1) (number, optional)

pkg/github/__toolsnaps__/add_issue_comment.snap

@@ -3,7 +3,7 @@
     "title": "Add comment to issue",
     "readOnlyHint": false
   },
-  "description": "Add a comment to a specific issue in a GitHub repository.",
+  "description": "Add a comment to a specific issue in a GitHub repository. Use this tool to add comments to pull requests as well (in this case pass pull request number as issue_number), but only if user is not asking specifically to add review comments.",
   "inputSchema": {
     "properties": {
       "body": {

pkg/github/__toolsnaps__/issue_read.snap

@@ -11,7 +11,7 @@
         "type": "number"
       },
       "method": {
-        "description": "The read operation to perform on a single issue. \nOptions are: \n1. 'get' - get issue details\n2. 'get_comments' - get issue comments\n3. 'get_sub_issues' - list sub-issues of the issue\n4. 'get_labels' - list labels assigned to the issue\n",
+        "description": "The read operation to perform on a single issue. \nOptions are: \n1. get - Get details of a specific issue.\n2. get_comments - Get issue comments.\n3. get_sub_issues - Get sub-issues of the issue.\n4. get_labels - Get labels assigned to the issue.\n",
         "enum": [
           "get",
           "get_comments",

pkg/github/__toolsnaps__/pull_request_read.snap

@@ -7,14 +7,15 @@
   "inputSchema": {
     "properties": {
       "method": {
-        "description": "Action to specify what pull request data needs to be retrieved from GitHub. \nPossible options: \n 1. get - Get details of a specific pull request.\n 2. get_diff - Get the diff of a pull request.\n 3. get_status - Get status of a head commit in a pull request. This reflects status of builds and checks.\n 4. get_files - Get the list of files changed in a pull request. Use with pagination parameters to control the number of results returned.\n 5. get_review_comments - Get the review comments on a pull request. Use with pagination parameters to control the number of results returned.\n 6. get_reviews - Get the reviews on a pull request. When asked for review comments, use get_review_comments method.\n",
+        "description": "Action to specify what pull request data needs to be retrieved from GitHub. \nPossible options: \n 1. get - Get details of a specific pull request.\n 2. get_diff - Get the diff of a pull request.\n 3. get_status - Get status of a head commit in a pull request. This reflects status of builds and checks.\n 4. get_files - Get the list of files changed in a pull request. Use with pagination parameters to control the number of results returned.\n 5. get_review_comments - Get the review comments on a pull request. They are comments made on a portion of the unified diff during a pull request review. Use with pagination parameters to control the number of results returned.\n 6. get_reviews - Get the reviews on a pull request. When asked for review comments, use get_review_comments method.\n 7. get_comments - Get comments on a pull request. Use this if user doesn't specifically want review comments. Use with pagination parameters to control the number of results returned.\n",
         "enum": [
           "get",
           "get_diff",
           "get_status",
           "get_files",
           "get_review_comments",
-          "get_reviews"
+          "get_reviews",
+          "get_comments"
         ],
         "type": "string"
       },