Skip to content

fix: shorten long tool name for adding pr review comments #697

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Jul 18, 2025
Merged

fix: shorten long tool name for adding pr review comments #697

merged 5 commits into from
Jul 18, 2025
+19 −19

Conversation

LuluBeatson
Copy link
Contributor

@LuluBeatson LuluBeatson commented Jul 18, 2025 •
edited
Loading

Shorten tool name to add_comment_to_pending_review

Reasoning:
Cursor has a limit of 60 characters for server name + tool name. Tools exceeding this don't show up.

  • Previous name: add_pull_request_review_comment_to_pending_review (length 49 characters)
  • New name: add_comment_to_pending_review (length 29 characters)

Closes: #582

@LuluBeatson LuluBeatson marked this pull request as ready for review July 18, 2025 09:19
@Copilot Copilot AI review requested due to automatic review settings July 18, 2025 09:19
@LuluBeatson LuluBeatson requested a review from a team as a code owner July 18, 2025 09:19
Copilot
Copilot AI reviewed Jul 18, 2025
View reviewed changes
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 shortens the tool name from add_pull_request_review_comment_to_pending_review to add_comment_to_pending_review to resolve a character limit issue in Cursor where tools with names exceeding 60 characters don't appear.

  • Function name changed from AddPullRequestReviewCommentToPendingReview to AddCommentToPendingReview
  • Tool name shortened from 49 to 29 characters while maintaining clarity
  • Updated all references across tests, documentation, and end-to-end tests

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
pkg/github/tools.go Updated function call to use new shortened tool name
pkg/github/pullrequests_test.go Updated test assertions and function calls to match new naming
pkg/github/pullrequests.go Renamed function and updated tool name, description, and translation keys
pkg/github/toolsnaps/add_comment_to_pending_review.snap Updated snapshot with new tool name and descriptions
e2e/e2e_test.go Updated end-to-end test calls to use new tool name
README.md Updated documentation to reflect new tool name and description

williammartin
williammartin approved these changes Jul 18, 2025
View reviewed changes
Copy link
Collaborator

@williammartin williammartin left a comment

Choose a reason for hiding this comment

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

Passes e2e test:

➜  github-mcp-server git:(lulu/fix-long-name) ✗ GOMAXPROCS=1 GITHUB_MCP_SERVER_E2E_HOST=https://github.com GITHUB_MCP_SERVER_E2E_TOKEN=$(gh auth token) go test -v -count=1 --tags e2e -run 'TestPullRequestReviewCommentSubmit' ./e2e

=== RUN   TestPullRequestReviewCommentSubmit
=== PAUSE TestPullRequestReviewCommentSubmit
=== CONT  TestPullRequestReviewCommentSubmit
    e2e_test.go:79: Building Docker image for e2e tests...
    e2e_test.go:162: Starting Stdio MCP client...
    e2e_test.go:1216: Getting current user...
    e2e_test.go:1245: Creating repository williammartin/github-mcp-server-e2e-TestPullRequestReviewCommentSubmit-1752830892961...
    e2e_test.go:1269: Creating branch in williammartin/github-mcp-server-e2e-TestPullRequestReviewCommentSubmit-1752830892961...
    e2e_test.go:1286: Creating commit with new file in williammartin/github-mcp-server-e2e-TestPullRequestReviewCommentSubmit-1752830892961...
    e2e_test.go:1315: Creating pull request in williammartin/github-mcp-server-e2e-TestPullRequestReviewCommentSubmit-1752830892961...
    e2e_test.go:1330: Creating pending review for pull request in williammartin/github-mcp-server-e2e-TestPullRequestReviewCommentSubmit-1752830892961...
    e2e_test.go:1351: Adding file review comment to pull request in williammartin/github-mcp-server-e2e-TestPullRequestReviewCommentSubmit-1752830892961...
    e2e_test.go:1371: Adding single line review comment to pull request in williammartin/github-mcp-server-e2e-TestPullRequestReviewCommentSubmit-1752830892961...
    e2e_test.go:1393: Adding multi line review comment to pull request in williammartin/github-mcp-server-e2e-TestPullRequestReviewCommentSubmit-1752830892961...
    e2e_test.go:1409: Submitting review for pull request in williammartin/github-mcp-server-e2e-TestPullRequestReviewCommentSubmit-1752830892961...
    e2e_test.go:1423: Getting reviews for pull request in williammartin/github-mcp-server-e2e-TestPullRequestReviewCommentSubmit-1752830892961...
    e2e_test.go:1254: Deleting repository williammartin/github-mcp-server-e2e-TestPullRequestReviewCommentSubmit-1752830892961...
--- PASS: TestPullRequestReviewCommentSubmit (19.09s)
PASS
ok      github.com/github/github-mcp-server/e2e 19.339s

@LuluBeatson LuluBeatson merged commit b5e3348 into main Jul 18, 2025
16 checks passed
@LuluBeatson LuluBeatson deleted the lulu/fix-long-name branch July 18, 2025 09:57
@BrewTestBot BrewTestBot mentioned this pull request Jul 18, 2025
Merged
LuluBeatson added a commit that referenced this pull request Jul 22, 2025
@martinnormark @LuluBeatson @tommaso-moro
Add tools for sub-issue endpoint (#470)
60a5391 
* Create 'add sub-issue' tool

* Fix hardcoded API host

* Create 'list sub-issues' tool

* Create 'remove sub-issue' tool

* Fix Test_GetIssue mock data - add missing User field

The assertion was already checking User.Login but the mock was incomplete

* Create 'reprioritize sub-issue' tool

* fixes

* use go github pck to add sub-issues

* Update to use go github package

* update description

* update to use go github v73

* lint, docs

* refactor: tests to use go-github-mock

* add toolsnaps

* make RemoveSubIssue use NewGitHubAPIErrorResponse, update docstring

* Always include SHA in get_file_contents responses (#676)

* fix: Add SHA to get_file_contents while preserving MCP behavior (#595)

Enhance get_file_contents to include SHA information without changing
the existing MCP server response format.

Changes:
- Add Contents API call to retrieve SHA before fetching raw content
- Include SHA in resourceURI (repo://owner/repo/sha/{SHA}/contents/path)
- Add SHA to success messages
- Update tests to verify SHA inclusion
- Maintain original behavior: text files return raw text, binaries return base64

This preserves backward compatibility while providing SHA information
for better file versioning support.

Closes #595

* fix: Improve error handling for Contents API response

Ensure response body is properly closed even when an error occurs by moving
the defer statement before the error check. This prevents potential resource
leaks when the Contents API returns an error with a non-nil response.

Changes:
- Move defer respContents.Body.Close() before error checking
- Rename errContents to err for consistency
- Add nil check for respContents before attempting to close body

This follows Go best practices for handling HTTP responses and prevents
potential goroutine/memory leaks.

* revert changes to resource URI

* use GraphQL API to get file SHA

* refactor: mock GQL client instead of getFileSHA function to follow conventions

* lint

* revert GraphQL

---------

Co-authored-by: LuluBeatson <[email protected]>

* Reorganize README, add dedicated install guides, include policies and governance info for the github server (#695)

* Refactor README and add host installation guides, governance docs

- Reorganized README for clarity and navigation
- Added dedicated installation guides for Claude, Cursor, Windsurf, JetBrains, and more
- Clarified contribution guidelines and approval criteria
- Added policies and governance documentation

* Update README.md

* Update README with configuration section for remote GitHub MCP Server

* Update MCP access policy description in README

Removing coding agent from the policy note, as the GitHub server is unaffected by this policy

* Update configuration steps for GitHub Copilot in JetBrains IDEs...

...to reflect changes in accessing settings and configuring MCP.

* Update install-other-copilot-ides.md

* Update Eclipse MCP support version and configuration steps...

...for GitHub Copilot plugin in installation guide.

* Update docs/installation-guides/install-cursor.md

* Update docs/installation-guides/install-windsurf.md

* Apply suggestion from @tonytrg

* Apply suggestion from @tonytrg

* Apply suggestion from @tonytrg

* Apply suggestion from @tonytrg

* Apply suggestion from @tonytrg

* Apply suggestion from @tonytrg

* Apply suggestion from @tonytrg

---------

Co-authored-by: Tony Truong <[email protected]>

* fix: shorten long tool name for adding pr review comments (#697)

* shorten tool name

* update function name to match tool name

* adjust wording of descriptions

* Update installation guide for GitHub MCP Server (#699)

* Update installation guide for GitHub MCP Server

Removed reference to GitHub.com in the installation guide. The GitHub server is available to Coding Agent by default, without installation needed.

* Rename section to 'Install in Other MCP Hosts'

Updating title for consistency and adding a link to the "other Copilot IDEs" install guide.

* Revise installation guide for Cursor MCP setup

Updated installation guide for Cursor with steps clarified, remote server installation, and one-click install deeplinks to open Cursor and add the github server to the config file.

* fix: make mcpcurl support "integer" type (#688)

- FYI:https://json-schema.org/understanding-json-schema/reference/numeric#integer

* Added installation instructions for mcpcurl (#719)

* Added installation instructions for mcpcurl

* Update cmd/mcpcurl/README.md

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>

* Add pagination support to GraphQL-based tools (#683)

* initial pagination for `ListDiscussions`

* redo category id var cast

* add GraphQL pagination support for discussion comments and categories

* remove pageinfo returns

* fix out ref for linter

* update docs

* move to unified pagination for consensus on params

* update docs

* refactor pagination handling

* update docs

* linter fix

* conv rest to gql params for safe lint

* add nolint

* add error handling for perPage value in ToGraphQLParams

* refactor pagination error handling

* unified params for rest andn graphql and rennamed to be uniform for golang

* add 'after' for pagination

* update docs

* Update pkg/github/discussions.go

Co-authored-by: Copilot <[email protected]>

* Update pkg/github/discussions.go

Co-authored-by: Copilot <[email protected]>

* Update pkg/github/discussions_test.go

Co-authored-by: Copilot <[email protected]>

* update default page size const

* reduce default pagination size from 100 to 30 in discussion tests

* update pagination for reverse and total

* update pagination to remove from discussions

* updated README

* improve the `ToGraphQLParams` function

---------

Co-authored-by: Copilot <[email protected]>

* shorten param descriptions

* fix: resp nil check in error handling in RemoveSubIssue function

---------

Co-authored-by: LuluBeatson <[email protected]>
Co-authored-by: tommaso-moro <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@williammartin williammartin williammartin approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

add_pull_request_review_comment_to_pending_review not found in toolset
2 participants
@LuluBeatson @williammartin