Conversation
… parameter usage Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
|
Agentic Changeset Generator triggered by this pull request. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation of the push_to_pull_request_branch tool's branch parameter to explicitly clarify that users should not provide the branch name when pushing changes from their current branch—the most common use case.
Key changes:
- Updated parameter description to be more explicit about when the branch parameter should be omitted
- Applied the change consistently across the source file and all workflow lock files
Reviewed Changes
Copilot reviewed 51 out of 51 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pkg/workflow/js/safe_outputs_mcp_server.cjs | Updated branch parameter description in tool definition to clarify usage |
| .github/workflows/*.lock.yml (54 files) | Propagated the updated description to all workflow lockfiles |
Comments suppressed due to low confidence (1)
pkg/workflow/js/safe_outputs_mcp_server.cjs:1
- [nitpick] The updated description contains redundancy. The sentence 'Do not provide this parameter if you want to push changes from the current branch' conveys the same meaning as 'If not provided, the current branch will be used.' Consider simplifying to: 'Optional branch name. Defaults to the current branch if not provided. Only specify this to push to a different branch.'
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Clarify branch name requirement for push pull request tool
Clarify push_to_pull_request_branch branch parameter is optional for current branch
Oct 25, 2025
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.
The
push_to_pull_request_branchtool description didn't clearly communicate that thebranchparameter should be omitted when pushing changes from the current branch.Changes
branchparameter description insafe_outputs_mcp_server.cjsto explicitly state "Do not provide this parameter if you want to push changes from the current branch"Before/After
This clarification helps users understand the typical use case: omit the parameter entirely to push changes from their current working branch.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.