-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Update list_commits
Filtering Descriptions
#634
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
list_commits
Descriptions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
perPage
parameter descriptions. - Refines
sha
andauthor
descriptions inlist_commits
to 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."),
list_commits
Descriptionslist_commits
Filtering Descriptions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
Fixes problems with
list_commit
: bad perPage and sha valuesUpdated paginationperPage
argument 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-descriptions
in the SHA argumentGet only the last 5 commits
✅ Agent correctly uses the
perPage
argument