From 29f641dde1e37f9c6c65f6ba8cccd81c5848e995 Mon Sep 17 00:00:00 2001 From: LuluBeatson Date: Thu, 3 Jul 2025 19:11:59 +0100 Subject: [PATCH 1/4] update sha arg description for list_commits, get_file_contents --- pkg/github/repositories.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pkg/github/repositories.go b/pkg/github/repositories.go index 29f776a056..cf71a58392 100644 --- a/pkg/github/repositories.go +++ b/pkg/github/repositories.go @@ -111,10 +111,10 @@ func ListCommits(getClient GetClientFn, t translations.TranslationHelperFunc) (t mcp.Description("Repository name"), ), mcp.WithString("sha", - mcp.Description("The commit SHA, branch name, or tag name to list commits from. If not specified, defaults to the repository's default branch."), + mcp.Description("Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA."), ), mcp.WithString("author", - mcp.Description("Author username or email address"), + mcp.Description("Author username or email address to filter commits by"), ), WithPagination(), ), @@ -470,7 +470,7 @@ func GetFileContents(getClient GetClientFn, getRawClient raw.GetRawClientFn, t t mcp.Description("Accepts optional git refs such as `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr_number}/head`"), ), mcp.WithString("sha", - mcp.Description("Accepts optional git sha, if sha is specified it will be used instead of ref"), + mcp.Description("Accepts optional commit SHA. If specified, it will be used instead of ref"), ), ), func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) { From b1da114f78a872e52693ebd75930297432adf7ea Mon Sep 17 00:00:00 2001 From: LuluBeatson Date: Thu, 3 Jul 2025 19:36:22 +0100 Subject: [PATCH 2/4] update perPage description for pagination to inform of default 30 --- pkg/github/server.go | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/pkg/github/server.go b/pkg/github/server.go index 85d078f1bc..777f6afcbf 100644 --- a/pkg/github/server.go +++ b/pkg/github/server.go @@ -175,7 +175,9 @@ func OptionalStringArrayParam(r mcp.CallToolRequest, p string) ([]string, error) } // WithPagination returns a ToolOption that adds "page" and "perPage" parameters to the tool. -// The "page" parameter is optional, min 1. The "perPage" parameter is optional, min 1, max 100. +// The "page" parameter is optional, min 1. +// The "perPage" parameter is optional, min 1, max 100. If unset, defaults to 30. +// https://docs.github.com/en/rest/using-the-rest-api/using-pagination-in-the-rest-api func WithPagination() mcp.ToolOption { return func(tool *mcp.Tool) { mcp.WithNumber("page", @@ -184,7 +186,7 @@ func WithPagination() mcp.ToolOption { )(tool) mcp.WithNumber("perPage", - mcp.Description("Results per page for pagination (min 1, max 100)"), + mcp.Description("Results per page for pagination (min 1, max 100). If unset, defaults to 30."), mcp.Min(1), mcp.Max(100), )(tool) From 26322aa18754a2b0c8f3f5ba7468ea295f482e76 Mon Sep 17 00:00:00 2001 From: LuluBeatson Date: Thu, 3 Jul 2025 19:49:24 +0100 Subject: [PATCH 3/4] toolsnaps, docs --- README.md | 44 +++++++++---------- pkg/github/__toolsnaps__/get_commit.snap | 2 +- .../__toolsnaps__/get_file_contents.snap | 2 +- .../__toolsnaps__/get_issue_comments.snap | 2 +- .../__toolsnaps__/get_pull_request_files.snap | 2 +- pkg/github/__toolsnaps__/list_branches.snap | 2 +- pkg/github/__toolsnaps__/list_commits.snap | 6 +-- pkg/github/__toolsnaps__/list_issues.snap | 2 +- .../__toolsnaps__/list_notifications.snap | 2 +- .../__toolsnaps__/list_pull_requests.snap | 2 +- pkg/github/__toolsnaps__/list_tags.snap | 2 +- pkg/github/__toolsnaps__/search_code.snap | 2 +- pkg/github/__toolsnaps__/search_issues.snap | 2 +- .../__toolsnaps__/search_pull_requests.snap | 2 +- .../__toolsnaps__/search_repositories.snap | 2 +- pkg/github/__toolsnaps__/search_users.snap | 2 +- 16 files changed, 39 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 68742752f3..dfcf32c61f 100644 --- a/README.md +++ b/README.md @@ -479,14 +479,14 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `filter`: Filters jobs by their completed_at timestamp (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **list_workflow_run_artifacts** - List workflow artifacts - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) @@ -496,7 +496,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `event`: Returns workflow runs for a specific event type (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `repo`: Repository name (string, required) - `status`: Returns workflow runs with the check run status (string, optional) - `workflow_id`: The workflow ID or workflow file name (string, required) @@ -504,7 +504,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **list_workflows** - List workflows - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `repo`: Repository name (string, required) - **rerun_failed_jobs** - Rerun failed jobs @@ -633,7 +633,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `issue_number`: Issue number (number, required) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `repo`: Repository name (string, required) - **list_issues** - List issues @@ -641,7 +641,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `labels`: Filter by labels (string[], optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `repo`: Repository name (string, required) - `since`: Filter by date (ISO 8601 timestamp) (string, optional) - `sort`: Sort order (string, optional) @@ -651,7 +651,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `order`: Sort order (string, optional) - `owner`: Optional repository owner. If provided with repo, only notifications 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) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (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) - `sort`: Sort field by number of matches of categories, defaults to best match (string, optional) @@ -685,7 +685,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `filter`: Filter notifications to, use default unless specified. Read notifications are ones that have already been acknowledged by the user. Participating notifications are those that the user is directly involved in, such as issues or pull requests they have commented on or created. (string, optional) - `owner`: Optional repository owner. If provided with repo, only notifications 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) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `repo`: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional) - `since`: Only show notifications updated after the given time (ISO 8601 format) (string, optional) @@ -712,7 +712,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **search_orgs** - Search organizations - `order`: Sort order (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `query`: Search query using GitHub organizations search syntax scoped to type:org (string, required) - `sort`: Sort field by category (string, optional) @@ -781,7 +781,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **get_pull_request_files** - Get pull request files - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `pullNumber`: Pull request number (number, required) - `repo`: Repository name (string, required) @@ -801,7 +801,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `head`: Filter by head user/org and branch (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `repo`: Repository name (string, required) - `sort`: Sort by (string, optional) - `state`: Filter by state (string, optional) @@ -823,7 +823,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `order`: Sort order (string, optional) - `owner`: Optional repository owner. If provided with repo, only notifications 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) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (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) - `sort`: Sort field by number of matches of categories, defaults to best match (string, optional) @@ -893,7 +893,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **get_commit** - Get commit details - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `repo`: Repository name (string, required) - `sha`: Commit SHA, branch name, or tag name (string, required) @@ -902,7 +902,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `path`: Path to file/directory (directories must end with a slash '/') (string, required) - `ref`: Accepts optional git refs such as `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr_number}/head` (string, optional) - `repo`: Repository name (string, required) - - `sha`: Accepts optional git sha, if sha is specified it will be used instead of ref (string, optional) + - `sha`: Accepts optional commit SHA. If specified, it will be used instead of ref (string, optional) - **get_tag** - Get tag details - `owner`: Repository owner (string, required) @@ -912,21 +912,21 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **list_branches** - List branches - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `repo`: Repository name (string, required) - **list_commits** - List commits - - `author`: Author username or email address (string, optional) + - `author`: Author username or email address to filter commits by (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `repo`: Repository name (string, required) - - `sha`: The commit SHA, branch name, or tag name to list commits from. If not specified, defaults to the repository's default branch. (string, optional) + - `sha`: Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA. (string, optional) - **list_tags** - List tags - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `repo`: Repository name (string, required) - **push_files** - Push files to repository @@ -939,13 +939,13 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **search_code** - Search code - `order`: Sort order (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `q`: Search query using GitHub code search syntax (string, required) - `sort`: Sort field ('indexed' only) (string, optional) - **search_repositories** - Search repositories - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `query`: Search query (string, required) @@ -975,7 +975,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **search_users** - Search users - `order`: Sort order (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) - `query`: Search query using GitHub users search syntax scoped to type:user (string, required) - `sort`: Sort field by category (string, optional) diff --git a/pkg/github/__toolsnaps__/get_commit.snap b/pkg/github/__toolsnaps__/get_commit.snap index af0038110f..d410194aca 100644 --- a/pkg/github/__toolsnaps__/get_commit.snap +++ b/pkg/github/__toolsnaps__/get_commit.snap @@ -16,7 +16,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/get_file_contents.snap b/pkg/github/__toolsnaps__/get_file_contents.snap index b3975abbc6..e550e8db80 100644 --- a/pkg/github/__toolsnaps__/get_file_contents.snap +++ b/pkg/github/__toolsnaps__/get_file_contents.snap @@ -23,7 +23,7 @@ "type": "string" }, "sha": { - "description": "Accepts optional git sha, if sha is specified it will be used instead of ref", + "description": "Accepts optional commit SHA. If specified, it will be used instead of ref", "type": "string" } }, diff --git a/pkg/github/__toolsnaps__/get_issue_comments.snap b/pkg/github/__toolsnaps__/get_issue_comments.snap index b28f452048..4098c12b6f 100644 --- a/pkg/github/__toolsnaps__/get_issue_comments.snap +++ b/pkg/github/__toolsnaps__/get_issue_comments.snap @@ -20,7 +20,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/get_pull_request_files.snap b/pkg/github/__toolsnaps__/get_pull_request_files.snap index 148053b173..254281e9a7 100644 --- a/pkg/github/__toolsnaps__/get_pull_request_files.snap +++ b/pkg/github/__toolsnaps__/get_pull_request_files.snap @@ -16,7 +16,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/list_branches.snap b/pkg/github/__toolsnaps__/list_branches.snap index 492b6d527d..65994556d4 100644 --- a/pkg/github/__toolsnaps__/list_branches.snap +++ b/pkg/github/__toolsnaps__/list_branches.snap @@ -16,7 +16,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/list_commits.snap b/pkg/github/__toolsnaps__/list_commits.snap index c43f7b0cda..04b89fdc7e 100644 --- a/pkg/github/__toolsnaps__/list_commits.snap +++ b/pkg/github/__toolsnaps__/list_commits.snap @@ -7,7 +7,7 @@ "inputSchema": { "properties": { "author": { - "description": "Author username or email address", + "description": "Author username or email address to filter commits by", "type": "string" }, "owner": { @@ -20,7 +20,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" @@ -30,7 +30,7 @@ "type": "string" }, "sha": { - "description": "The commit SHA, branch name, or tag name to list commits from. If not specified, defaults to the repository's default branch.", + "description": "Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA.", "type": "string" } }, diff --git a/pkg/github/__toolsnaps__/list_issues.snap b/pkg/github/__toolsnaps__/list_issues.snap index 4fe155f09c..ce6e05c6ea 100644 --- a/pkg/github/__toolsnaps__/list_issues.snap +++ b/pkg/github/__toolsnaps__/list_issues.snap @@ -31,7 +31,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/list_notifications.snap b/pkg/github/__toolsnaps__/list_notifications.snap index 92f25eb4c5..0925f6c8f7 100644 --- a/pkg/github/__toolsnaps__/list_notifications.snap +++ b/pkg/github/__toolsnaps__/list_notifications.snap @@ -29,7 +29,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/list_pull_requests.snap b/pkg/github/__toolsnaps__/list_pull_requests.snap index b8369784d7..c4187f56ee 100644 --- a/pkg/github/__toolsnaps__/list_pull_requests.snap +++ b/pkg/github/__toolsnaps__/list_pull_requests.snap @@ -32,7 +32,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/list_tags.snap b/pkg/github/__toolsnaps__/list_tags.snap index fcb9853fdd..fd1262898f 100644 --- a/pkg/github/__toolsnaps__/list_tags.snap +++ b/pkg/github/__toolsnaps__/list_tags.snap @@ -16,7 +16,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/search_code.snap b/pkg/github/__toolsnaps__/search_code.snap index c85d6674d8..3afc07dfac 100644 --- a/pkg/github/__toolsnaps__/search_code.snap +++ b/pkg/github/__toolsnaps__/search_code.snap @@ -20,7 +20,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/search_issues.snap b/pkg/github/__toolsnaps__/search_issues.snap index 7db502d947..b3d3eba5c7 100644 --- a/pkg/github/__toolsnaps__/search_issues.snap +++ b/pkg/github/__toolsnaps__/search_issues.snap @@ -24,7 +24,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/search_pull_requests.snap b/pkg/github/__toolsnaps__/search_pull_requests.snap index 6a8d8e0e6b..cbe1f53bf5 100644 --- a/pkg/github/__toolsnaps__/search_pull_requests.snap +++ b/pkg/github/__toolsnaps__/search_pull_requests.snap @@ -24,7 +24,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/search_repositories.snap b/pkg/github/__toolsnaps__/search_repositories.snap index b6b6d1d44b..37f3f9dee0 100644 --- a/pkg/github/__toolsnaps__/search_repositories.snap +++ b/pkg/github/__toolsnaps__/search_repositories.snap @@ -12,7 +12,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/search_users.snap b/pkg/github/__toolsnaps__/search_users.snap index 5cf9796f25..bf4ab904bd 100644 --- a/pkg/github/__toolsnaps__/search_users.snap +++ b/pkg/github/__toolsnaps__/search_users.snap @@ -20,7 +20,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100)", + "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", "maximum": 100, "minimum": 1, "type": "number" From 0fbb9232ca9765e1f298979e6d0a48dfc935d909 Mon Sep 17 00:00:00 2001 From: LuluBeatson Date: Mon, 7 Jul 2025 11:53:34 +0100 Subject: [PATCH 4/4] revert perPage description --- README.md | 38 +++++++++---------- pkg/github/__toolsnaps__/get_commit.snap | 2 +- .../__toolsnaps__/get_issue_comments.snap | 2 +- .../__toolsnaps__/get_pull_request_files.snap | 2 +- pkg/github/__toolsnaps__/list_branches.snap | 2 +- pkg/github/__toolsnaps__/list_commits.snap | 2 +- pkg/github/__toolsnaps__/list_issues.snap | 2 +- .../__toolsnaps__/list_notifications.snap | 2 +- .../__toolsnaps__/list_pull_requests.snap | 2 +- pkg/github/__toolsnaps__/list_tags.snap | 2 +- pkg/github/__toolsnaps__/search_code.snap | 2 +- pkg/github/__toolsnaps__/search_issues.snap | 2 +- .../__toolsnaps__/search_pull_requests.snap | 2 +- .../__toolsnaps__/search_repositories.snap | 2 +- pkg/github/__toolsnaps__/search_users.snap | 2 +- pkg/github/server.go | 2 +- 16 files changed, 34 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index dfcf32c61f..b281ad0427 100644 --- a/README.md +++ b/README.md @@ -479,14 +479,14 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `filter`: Filters jobs by their completed_at timestamp (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) - **list_workflow_run_artifacts** - List workflow artifacts - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) @@ -496,7 +496,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `event`: Returns workflow runs for a specific event type (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - `status`: Returns workflow runs with the check run status (string, optional) - `workflow_id`: The workflow ID or workflow file name (string, required) @@ -504,7 +504,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **list_workflows** - List workflows - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - **rerun_failed_jobs** - Rerun failed jobs @@ -633,7 +633,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `issue_number`: Issue number (number, required) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - **list_issues** - List issues @@ -641,7 +641,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `labels`: Filter by labels (string[], optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - `since`: Filter by date (ISO 8601 timestamp) (string, optional) - `sort`: Sort order (string, optional) @@ -651,7 +651,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `order`: Sort order (string, optional) - `owner`: Optional repository owner. If provided with repo, only notifications 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). If unset, defaults to 30. (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) - `sort`: Sort field by number of matches of categories, defaults to best match (string, optional) @@ -685,7 +685,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `filter`: Filter notifications to, use default unless specified. Read notifications are ones that have already been acknowledged by the user. Participating notifications are those that the user is directly involved in, such as issues or pull requests they have commented on or created. (string, optional) - `owner`: Optional repository owner. If provided with repo, only notifications 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). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional) - `since`: Only show notifications updated after the given time (ISO 8601 format) (string, optional) @@ -712,7 +712,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **search_orgs** - Search organizations - `order`: Sort order (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `query`: Search query using GitHub organizations search syntax scoped to type:org (string, required) - `sort`: Sort field by category (string, optional) @@ -781,7 +781,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **get_pull_request_files** - Get pull request files - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `pullNumber`: Pull request number (number, required) - `repo`: Repository name (string, required) @@ -801,7 +801,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `head`: Filter by head user/org and branch (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - `sort`: Sort by (string, optional) - `state`: Filter by state (string, optional) @@ -823,7 +823,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - `order`: Sort order (string, optional) - `owner`: Optional repository owner. If provided with repo, only notifications 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). If unset, defaults to 30. (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) - `sort`: Sort field by number of matches of categories, defaults to best match (string, optional) @@ -893,7 +893,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **get_commit** - Get commit details - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - `sha`: Commit SHA, branch name, or tag name (string, required) @@ -912,21 +912,21 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **list_branches** - List branches - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - **list_commits** - List commits - `author`: Author username or email address to filter commits by (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - `sha`: Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA. (string, optional) - **list_tags** - List tags - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - **push_files** - Push files to repository @@ -939,13 +939,13 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **search_code** - Search code - `order`: Sort order (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `q`: Search query using GitHub code search syntax (string, required) - `sort`: Sort field ('indexed' only) (string, optional) - **search_repositories** - Search repositories - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `query`: Search query (string, required) @@ -975,7 +975,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description - **search_users** - Search users - `order`: Sort order (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - - `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional) + - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `query`: Search query using GitHub users search syntax scoped to type:user (string, required) - `sort`: Sort field by category (string, optional) diff --git a/pkg/github/__toolsnaps__/get_commit.snap b/pkg/github/__toolsnaps__/get_commit.snap index d410194aca..af0038110f 100644 --- a/pkg/github/__toolsnaps__/get_commit.snap +++ b/pkg/github/__toolsnaps__/get_commit.snap @@ -16,7 +16,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/get_issue_comments.snap b/pkg/github/__toolsnaps__/get_issue_comments.snap index 4098c12b6f..b28f452048 100644 --- a/pkg/github/__toolsnaps__/get_issue_comments.snap +++ b/pkg/github/__toolsnaps__/get_issue_comments.snap @@ -20,7 +20,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/get_pull_request_files.snap b/pkg/github/__toolsnaps__/get_pull_request_files.snap index 254281e9a7..148053b173 100644 --- a/pkg/github/__toolsnaps__/get_pull_request_files.snap +++ b/pkg/github/__toolsnaps__/get_pull_request_files.snap @@ -16,7 +16,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/list_branches.snap b/pkg/github/__toolsnaps__/list_branches.snap index 65994556d4..492b6d527d 100644 --- a/pkg/github/__toolsnaps__/list_branches.snap +++ b/pkg/github/__toolsnaps__/list_branches.snap @@ -16,7 +16,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/list_commits.snap b/pkg/github/__toolsnaps__/list_commits.snap index 04b89fdc7e..a802436c2d 100644 --- a/pkg/github/__toolsnaps__/list_commits.snap +++ b/pkg/github/__toolsnaps__/list_commits.snap @@ -20,7 +20,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/list_issues.snap b/pkg/github/__toolsnaps__/list_issues.snap index ce6e05c6ea..4fe155f09c 100644 --- a/pkg/github/__toolsnaps__/list_issues.snap +++ b/pkg/github/__toolsnaps__/list_issues.snap @@ -31,7 +31,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/list_notifications.snap b/pkg/github/__toolsnaps__/list_notifications.snap index 0925f6c8f7..92f25eb4c5 100644 --- a/pkg/github/__toolsnaps__/list_notifications.snap +++ b/pkg/github/__toolsnaps__/list_notifications.snap @@ -29,7 +29,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/list_pull_requests.snap b/pkg/github/__toolsnaps__/list_pull_requests.snap index c4187f56ee..b8369784d7 100644 --- a/pkg/github/__toolsnaps__/list_pull_requests.snap +++ b/pkg/github/__toolsnaps__/list_pull_requests.snap @@ -32,7 +32,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/list_tags.snap b/pkg/github/__toolsnaps__/list_tags.snap index fd1262898f..fcb9853fdd 100644 --- a/pkg/github/__toolsnaps__/list_tags.snap +++ b/pkg/github/__toolsnaps__/list_tags.snap @@ -16,7 +16,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/search_code.snap b/pkg/github/__toolsnaps__/search_code.snap index 3afc07dfac..c85d6674d8 100644 --- a/pkg/github/__toolsnaps__/search_code.snap +++ b/pkg/github/__toolsnaps__/search_code.snap @@ -20,7 +20,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/search_issues.snap b/pkg/github/__toolsnaps__/search_issues.snap index b3d3eba5c7..7db502d947 100644 --- a/pkg/github/__toolsnaps__/search_issues.snap +++ b/pkg/github/__toolsnaps__/search_issues.snap @@ -24,7 +24,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/search_pull_requests.snap b/pkg/github/__toolsnaps__/search_pull_requests.snap index cbe1f53bf5..6a8d8e0e6b 100644 --- a/pkg/github/__toolsnaps__/search_pull_requests.snap +++ b/pkg/github/__toolsnaps__/search_pull_requests.snap @@ -24,7 +24,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/search_repositories.snap b/pkg/github/__toolsnaps__/search_repositories.snap index 37f3f9dee0..b6b6d1d44b 100644 --- a/pkg/github/__toolsnaps__/search_repositories.snap +++ b/pkg/github/__toolsnaps__/search_repositories.snap @@ -12,7 +12,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/__toolsnaps__/search_users.snap b/pkg/github/__toolsnaps__/search_users.snap index bf4ab904bd..5cf9796f25 100644 --- a/pkg/github/__toolsnaps__/search_users.snap +++ b/pkg/github/__toolsnaps__/search_users.snap @@ -20,7 +20,7 @@ "type": "number" }, "perPage": { - "description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.", + "description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number" diff --git a/pkg/github/server.go b/pkg/github/server.go index 777f6afcbf..e7b831791c 100644 --- a/pkg/github/server.go +++ b/pkg/github/server.go @@ -186,7 +186,7 @@ func WithPagination() mcp.ToolOption { )(tool) mcp.WithNumber("perPage", - mcp.Description("Results per page for pagination (min 1, max 100). If unset, defaults to 30."), + mcp.Description("Results per page for pagination (min 1, max 100)"), mcp.Min(1), mcp.Max(100), )(tool)