Skip to content

Commit d65d1d5

Browse files
authored
fix: correct descriptions for PR/issue searching (#840)
Fix #839 by updating the descriptions for the `owner` and `repo` parameters for the `search_issues` and `search_pull_requests` tools to no longer reference notifications but issues and pull requests, respectively.
1 parent 521d5e9 commit d65d1d5

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -572,11 +572,11 @@ The following sets of tools are available (all are on by default):
572572

573573
- **search_issues** - Search issues
574574
- `order`: Sort order (string, optional)
575-
- `owner`: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional)
575+
- `owner`: Optional repository owner. If provided with repo, only issues for this repository are listed. (string, optional)
576576
- `page`: Page number for pagination (min 1) (number, optional)
577577
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
578578
- `query`: Search query using GitHub issues search syntax (string, required)
579-
- `repo`: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional)
579+
- `repo`: Optional repository name. If provided with owner, only issues for this repository are listed. (string, optional)
580580
- `sort`: Sort field by number of matches of categories, defaults to best match (string, optional)
581581

582582
- **update_issue** - Edit issue
@@ -744,11 +744,11 @@ The following sets of tools are available (all are on by default):
744744

745745
- **search_pull_requests** - Search pull requests
746746
- `order`: Sort order (string, optional)
747-
- `owner`: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional)
747+
- `owner`: Optional repository owner. If provided with repo, only pull requests for this repository are listed. (string, optional)
748748
- `page`: Page number for pagination (min 1) (number, optional)
749749
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
750750
- `query`: Search query using GitHub pull request search syntax (string, required)
751-
- `repo`: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional)
751+
- `repo`: Optional repository name. If provided with owner, only pull requests for this repository are listed. (string, optional)
752752
- `sort`: Sort field by number of matches of categories, defaults to best match (string, optional)
753753

754754
- **submit_pending_pull_request_review** - Submit the requester's latest pending pull request review

pkg/github/__toolsnaps__/search_issues.snap

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"type": "string"
1616
},
1717
"owner": {
18-
"description": "Optional repository owner. If provided with repo, only notifications for this repository are listed.",
18+
"description": "Optional repository owner. If provided with repo, only issues for this repository are listed.",
1919
"type": "string"
2020
},
2121
"page": {
@@ -34,7 +34,7 @@
3434
"type": "string"
3535
},
3636
"repo": {
37-
"description": "Optional repository name. If provided with owner, only notifications for this repository are listed.",
37+
"description": "Optional repository name. If provided with owner, only issues for this repository are listed.",
3838
"type": "string"
3939
},
4040
"sort": {

pkg/github/__toolsnaps__/search_pull_requests.snap

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"type": "string"
1616
},
1717
"owner": {
18-
"description": "Optional repository owner. If provided with repo, only notifications for this repository are listed.",
18+
"description": "Optional repository owner. If provided with repo, only pull requests for this repository are listed.",
1919
"type": "string"
2020
},
2121
"page": {
@@ -34,7 +34,7 @@
3434
"type": "string"
3535
},
3636
"repo": {
37-
"description": "Optional repository name. If provided with owner, only notifications for this repository are listed.",
37+
"description": "Optional repository name. If provided with owner, only pull requests for this repository are listed.",
3838
"type": "string"
3939
},
4040
"sort": {

pkg/github/issues.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -569,10 +569,10 @@ func SearchIssues(getClient GetClientFn, t translations.TranslationHelperFunc) (
569569
mcp.Description("Search query using GitHub issues search syntax"),
570570
),
571571
mcp.WithString("owner",
572-
mcp.Description("Optional repository owner. If provided with repo, only notifications for this repository are listed."),
572+
mcp.Description("Optional repository owner. If provided with repo, only issues for this repository are listed."),
573573
),
574574
mcp.WithString("repo",
575-
mcp.Description("Optional repository name. If provided with owner, only notifications for this repository are listed."),
575+
mcp.Description("Optional repository name. If provided with owner, only issues for this repository are listed."),
576576
),
577577
mcp.WithString("sort",
578578
mcp.Description("Sort field by number of matches of categories, defaults to best match"),

pkg/github/pullrequests.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -691,10 +691,10 @@ func SearchPullRequests(getClient GetClientFn, t translations.TranslationHelperF
691691
mcp.Description("Search query using GitHub pull request search syntax"),
692692
),
693693
mcp.WithString("owner",
694-
mcp.Description("Optional repository owner. If provided with repo, only notifications for this repository are listed."),
694+
mcp.Description("Optional repository owner. If provided with repo, only pull requests for this repository are listed."),
695695
),
696696
mcp.WithString("repo",
697-
mcp.Description("Optional repository name. If provided with owner, only notifications for this repository are listed."),
697+
mcp.Description("Optional repository name. If provided with owner, only pull requests for this repository are listed."),
698698
),
699699
mcp.WithString("sort",
700700
mcp.Description("Sort field by number of matches of categories, defaults to best match"),

0 commit comments

Comments
 (0)