Skip to content

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

Merged
merged 6 commits into from
Jul 7, 2025
Merged

Conversation

LuluBeatson
Copy link
Contributor

@LuluBeatson LuluBeatson commented Jul 3, 2025

Fixes problems with list_commit: bad perPage and sha values

  1. (reverted) Updated pagination perPage 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.
  2. Updated list_commits' filtering argument (sha, author) descriptions to clarify how they are used

API docs about pagination: https://docs.github.com/en/rest/using-the-rest-api/using-pagination-in-the-rest-api

Summarise the last 2 commits

Summarize the last 2 commits in https://github.com/github/github-mcp-server/pull/634

✅ Agent correctly gets PR details then uses a the branch lulu/tool-descriptions in the SHA argument

image image
Get only the last 5 commits

Get only the last 5 commits in github/github-mcp-server

✅ Agent correctly uses the perPage argument

image

@LuluBeatson LuluBeatson changed the title Update Tool Descriptions Update Pagination & list_commits Descriptions Jul 7, 2025
@LuluBeatson LuluBeatson marked this pull request as ready for review July 7, 2025 09:46
@Copilot Copilot AI review requested due to automatic review settings July 7, 2025 09:46
@LuluBeatson LuluBeatson requested a review from a team as a code owner July 7, 2025 09:46
Copy link
Contributor

@Copilot Copilot AI left a 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 and author descriptions in list_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."),

@LuluBeatson LuluBeatson requested a review from tonytrg July 7, 2025 10:55
@LuluBeatson LuluBeatson changed the title Update Pagination & list_commits Descriptions Update list_commits Filtering Descriptions Jul 7, 2025
Copy link
Contributor

@tonytrg tonytrg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@LuluBeatson LuluBeatson merged commit 39d7fec into main Jul 7, 2025
16 checks passed
@LuluBeatson LuluBeatson deleted the lulu/tool-descriptions branch July 7, 2025 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy