feat: add pagination support to get_pull_request_files tool #561
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.
Add pagination support to
get_pull_request_filestoolFixes #527
Problem
The
get_pull_request_filestool currently retrieves only the first 30 files with diffs of any PR that contains more than 30 files. This is a limitation because large PRs with many files cannot be fully analyzed.Solution
Added pagination support to the
get_pull_request_filestool by:WithPagination()to the tool definitionOptionalPaginationParams(request)to handlepageandperPageparametersListFilescallChanges Made
1. Core Implementation (
pkg/github/pullrequests.go)2. Test Updates (
pkg/github/pullrequests_test.go)page,perPage) are present in tool schema3. Schema Snapshot (
pkg/github/__toolsnaps__/get_pull_request_files.snap)Testing Done
1. Unit Tests
Test Results:
Test_GetPullRequestFiles- All test cases pass including new pagination testpageandperPageparameters are present2. Integration Testing
Schema Verification:
{ "name": "get_pull_request_files", "inputSchema": { "properties": { "owner": {"description": "Repository owner", "type": "string"}, "page": {"description": "Page number for pagination (min 1)", "minimum": 1, "type": "number"}, "perPage": {"description": "Results per page for pagination (min 1, max 100)", "maximum": 100, "minimum": 1, "type": "number"}, "pullNumber": {"description": "Pull request number", "type": "number"}, "repo": {"description": "Repository name", "type": "string"} }, "required": ["owner", "repo", "pullNumber"] } }3. GitHub API Verification
API Response: Successfully returned paginated results with 2 files per page.
4. Build Verification
# Server builds successfully with changes go build -o github-mcp-server cmd/github-mcp-server/main.goUsage Examples
Default behavior (no pagination parameters):
{ "owner": "github", "repo": "github-mcp-server", "pullNumber": 123 }With pagination:
{ "owner": "github", "repo": "github-mcp-server", "pullNumber": 123, "page": 2, "perPage": 10 }Backward Compatibility
pageandperPageare optional with sensible defaultsImpact
Files Changed
pkg/github/pullrequests.go- Core implementationpkg/github/pullrequests_test.go- Test updatespkg/github/__toolsnaps__/get_pull_request_files.snap- Schema snapshot