From 6bfe8311171deff616012bb6ad58ec658080c868 Mon Sep 17 00:00:00 2001 From: Kirsten Laskoski Date: Thu, 7 Aug 2025 21:24:44 -0400 Subject: [PATCH] fix: correct descriptions for PR/issue searching 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. --- README.md | 8 ++++---- pkg/github/__toolsnaps__/search_issues.snap | 4 ++-- pkg/github/__toolsnaps__/search_pull_requests.snap | 4 ++-- pkg/github/issues.go | 4 ++-- pkg/github/pullrequests.go | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b2b8cfafc..acbf717f0 100644 --- a/README.md +++ b/README.md @@ -572,11 +572,11 @@ The following sets of tools are available (all are on by default): - **search_issues** - Search issues - `order`: Sort order (string, optional) - - `owner`: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional) + - `owner`: Optional repository owner. If provided with repo, only issues for this repository are listed. (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `query`: Search query using GitHub issues search syntax (string, required) - - `repo`: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional) + - `repo`: Optional repository name. If provided with owner, only issues for this repository are listed. (string, optional) - `sort`: Sort field by number of matches of categories, defaults to best match (string, optional) - **update_issue** - Edit issue @@ -744,11 +744,11 @@ The following sets of tools are available (all are on by default): - **search_pull_requests** - Search pull requests - `order`: Sort order (string, optional) - - `owner`: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional) + - `owner`: Optional repository owner. If provided with repo, only pull requests for this repository are listed. (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `query`: Search query using GitHub pull request search syntax (string, required) - - `repo`: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional) + - `repo`: Optional repository name. If provided with owner, only pull requests for this repository are listed. (string, optional) - `sort`: Sort field by number of matches of categories, defaults to best match (string, optional) - **submit_pending_pull_request_review** - Submit the requester's latest pending pull request review diff --git a/pkg/github/__toolsnaps__/search_issues.snap b/pkg/github/__toolsnaps__/search_issues.snap index 7db502d94..bf1982411 100644 --- a/pkg/github/__toolsnaps__/search_issues.snap +++ b/pkg/github/__toolsnaps__/search_issues.snap @@ -15,7 +15,7 @@ "type": "string" }, "owner": { - "description": "Optional repository owner. If provided with repo, only notifications for this repository are listed.", + "description": "Optional repository owner. If provided with repo, only issues for this repository are listed.", "type": "string" }, "page": { @@ -34,7 +34,7 @@ "type": "string" }, "repo": { - "description": "Optional repository name. If provided with owner, only notifications for this repository are listed.", + "description": "Optional repository name. If provided with owner, only issues for this repository are listed.", "type": "string" }, "sort": { diff --git a/pkg/github/__toolsnaps__/search_pull_requests.snap b/pkg/github/__toolsnaps__/search_pull_requests.snap index 6a8d8e0e6..811aa1322 100644 --- a/pkg/github/__toolsnaps__/search_pull_requests.snap +++ b/pkg/github/__toolsnaps__/search_pull_requests.snap @@ -15,7 +15,7 @@ "type": "string" }, "owner": { - "description": "Optional repository owner. If provided with repo, only notifications for this repository are listed.", + "description": "Optional repository owner. If provided with repo, only pull requests for this repository are listed.", "type": "string" }, "page": { @@ -34,7 +34,7 @@ "type": "string" }, "repo": { - "description": "Optional repository name. If provided with owner, only notifications for this repository are listed.", + "description": "Optional repository name. If provided with owner, only pull requests for this repository are listed.", "type": "string" }, "sort": { diff --git a/pkg/github/issues.go b/pkg/github/issues.go index 1cf8768db..de35dac12 100644 --- a/pkg/github/issues.go +++ b/pkg/github/issues.go @@ -569,10 +569,10 @@ func SearchIssues(getClient GetClientFn, t translations.TranslationHelperFunc) ( mcp.Description("Search query using GitHub issues search syntax"), ), mcp.WithString("owner", - mcp.Description("Optional repository owner. If provided with repo, only notifications for this repository are listed."), + mcp.Description("Optional repository owner. If provided with repo, only issues for this repository are listed."), ), mcp.WithString("repo", - mcp.Description("Optional repository name. If provided with owner, only notifications for this repository are listed."), + mcp.Description("Optional repository name. If provided with owner, only issues for this repository are listed."), ), mcp.WithString("sort", mcp.Description("Sort field by number of matches of categories, defaults to best match"), diff --git a/pkg/github/pullrequests.go b/pkg/github/pullrequests.go index b087062dd..63c5594d3 100644 --- a/pkg/github/pullrequests.go +++ b/pkg/github/pullrequests.go @@ -691,10 +691,10 @@ func SearchPullRequests(getClient GetClientFn, t translations.TranslationHelperF mcp.Description("Search query using GitHub pull request search syntax"), ), mcp.WithString("owner", - mcp.Description("Optional repository owner. If provided with repo, only notifications for this repository are listed."), + mcp.Description("Optional repository owner. If provided with repo, only pull requests for this repository are listed."), ), mcp.WithString("repo", - mcp.Description("Optional repository name. If provided with owner, only notifications for this repository are listed."), + mcp.Description("Optional repository name. If provided with owner, only pull requests for this repository are listed."), ), mcp.WithString("sort", mcp.Description("Sort field by number of matches of categories, defaults to best match"),