Update list_commits Filtering Descriptions
#634
Merged
+12
−10
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LuluBeatson
changed the title
list_commits Descriptions
There was a problem hiding this comment.
Pull Request Overview
This PR updates pagination descriptions to include the default per-page value and clarifies filtering argument descriptions for list_commits.
- Adds “If unset, defaults to 30” to all
perPageparameter descriptions. - Refines
shaandauthordescriptions inlist_commitsto explain their behavior. - Updates generated tool snapshots and the README to reflect these description changes.
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pkg/github/server.go | Added default behavior and docs link to perPage description |
| pkg/github/repositories.go | Improved sha and author descriptions in ListCommits |
| pkg/github/toolsnaps/search_users.snap | Updated perPage default in snapshot |
| pkg/github/toolsnaps/search_repositories.snap | Updated perPage default in snapshot |
| pkg/github/toolsnaps/search_pull_requests.snap | Updated perPage default in snapshot |
| pkg/github/toolsnaps/search_issues.snap | Updated perPage default in snapshot |
| pkg/github/toolsnaps/search_code.snap | Updated perPage default in snapshot |
| pkg/github/toolsnaps/list_tags.snap | Updated perPage default in snapshot |
| pkg/github/toolsnaps/list_pull_requests.snap | Updated perPage default in snapshot |
| pkg/github/toolsnaps/list_notifications.snap | Updated perPage default in snapshot |
| pkg/github/toolsnaps/list_issues.snap | Updated perPage default in snapshot |
| pkg/github/toolsnaps/list_commits.snap | Updated perPage, sha, and author in snapshot |
| pkg/github/toolsnaps/list_branches.snap | Updated perPage default in snapshot |
| pkg/github/toolsnaps/get_pull_request_files.snap | Updated perPage default in snapshot |
| pkg/github/toolsnaps/get_issue_comments.snap | Updated perPage default in snapshot |
| pkg/github/toolsnaps/get_file_contents.snap | Clarified sha description in snapshot |
| pkg/github/toolsnaps/get_commit.snap | Updated perPage default in snapshot |
| README.md | Added default-perPage note and clarified sha/author entries |
Comments suppressed due to low confidence (1)
pkg/github/repositories.go:114
- [nitpick] The phrase 'to list commits of' is awkward and 'up to that SHA' might be confusing. Consider rephrasing to: 'Commit SHA, branch, or tag name to list commits from. Defaults to the repository’s default branch if not provided. When a SHA is supplied, listing begins from that commit.'
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."),
tonytrg
reviewed
Jul 7, 2025
LuluBeatson
changed the title
list_commits Descriptionslist_commits Filtering Descriptions
nickytonline
pushed a commit
to nickytonline/github-mcp-http
that referenced
this pull request
Oct 4, 2025
* update sha arg description for list_commits, get_file_contents * update perPage description for pagination to inform of default 30 * toolsnaps, docs * revert perPage description
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes problems with
list_commit: bad perPage and sha valuesUpdated paginationperPageargument description to include "If unset, defaults to 30". This affects a lot of tools and is why the toolsnaps and README diff is large.list_commits' filtering argument (sha,author) descriptions to clarify how they are usedAPI docs about pagination: https://docs.github.com/en/rest/using-the-rest-api/using-pagination-in-the-rest-api
Summarise the last 2 commits
✅ Agent correctly gets PR details then uses a the branch
lulu/tool-descriptionsin the SHA argumentGet only the last 5 commits
✅ Agent correctly uses the
perPageargument