Clarify pull_request_review_write title notes pending review creation#2837
Open
JuggerGrimrod88 wants to merge 1 commit into
Open
Clarify pull_request_review_write title notes pending review creation#2837JuggerGrimrod88 wants to merge 1 commit into
JuggerGrimrod88 wants to merge 1 commit into
Conversation
Update the pull_request_review_write tool Title annotation from "Write operations (create, submit, delete) on pull request reviews" to "Create (pending), submit, or delete pull request reviews". The parenthetical scopes "pending" to the create action: method: "create" opens a pending review when the event parameter is omitted, and submits immediately when event is supplied. MCP clients that surface only the short title previously implied that create submits a review; the new title surfaces the pending-by-default behavior at a glance. The description body already documents the event-conditional behavior; only the short title was misleading. Closes github#2524. Co-Authored-By: Claude <noreply@anthropic.com>
7454e56 to
1bc0ece
Compare
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
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.
What
Updates the
Titleannotation of thepull_request_review_writetool from:to:
Why
When an MCP client (e.g. Claude Code) surfaces only a tool's short title,
method: "create"reads as "create a review" — implying the review is created and submitted. In reality, when theeventparameter is omitted,createopens a pending review that is not submitted; it must later be submitted viamethod: "submit_pending". The description body already documents this correctly, but the short title — the part many clients actually show — was misleading.The parenthetical scopes "pending" to the
createaction:createopens a pending review wheneventis omitted, and submits immediately wheneventis supplied. This surfaces the pending-by-default behavior at a glance without overclaiming thatcreateis always pending. No behavior, schema, or API change.Closes #2524.
Wording
This follows the wording suggested in the issue, tightened to a parenthetical so "pending" reads as an attribute of
createrather than a synonym for it (sincecreatewitheventdoes submit). If a maintainer prefers different phrasing — e.g. the issue's alternate"Pending review create / submit / delete for pull requests"— it's a one-line change.Verification
gofmt -lclean.go vet ./pkg/github/go build ./...go test ./pkg/github/ -run 'TestCreateAndSubmitPullRequestReview|TestCreatePendingPullRequestReview|TestSubmitPendingPullRequestReview|TestDeletePendingPullRequestReview'— green.pull_request_review_writegolden snapshot (pkg/github/__toolsnaps__/pull_request_review_write.snap) viaUPDATE_TOOLSNAPS=true; the only delta is thetitlefield, matching the code change.