Skip to content

Clarify push_to_pull_request_branch branch parameter is optional for current branch#2437

Merged
pelikhan merged 4 commits intomainfrom
copilot/update-push-pull-request-tool
Oct 25, 2025
Merged

Clarify push_to_pull_request_branch branch parameter is optional for current branch#2437
pelikhan merged 4 commits intomainfrom
copilot/update-push-pull-request-tool

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Oct 25, 2025

The push_to_pull_request_branch tool description didn't clearly communicate that the branch parameter should be omitted when pushing changes from the current branch.

Changes

  • Updated the branch parameter description in safe_outputs_mcp_server.cjs to explicitly state "Do not provide this parameter if you want to push changes from the current branch"

Before/After

// Before
branch: {
  type: "string",
  description: "Optional branch name. If not provided, the current branch will be used."
}

// After
branch: {
  type: "string",
  description: "Optional branch name. Do not provide this parameter if you want to push changes from the current branch. If not provided, the current branch will be used."
}

This clarification helps users understand the typical use case: omit the parameter entirely to push changes from their current working branch.

Original prompt

review the push_pull_request_to_branch tool description in the safe output MCP server make sure that it is clear that the branch name does not need to be provided if the changes in the current branch should be pushed.


💡 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.

… parameter usage

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan pelikhan marked this pull request as ready for review October 25, 2025 14:59
Copilot AI review requested due to automatic review settings October 25, 2025 14:59
@github-actions
Copy link
Copy Markdown
Contributor

Agentic Changeset Generator triggered by this pull request.

Copy link
Copy Markdown
Contributor

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 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.

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
Copilot AI requested a review from pelikhan October 25, 2025 15:05
@pelikhan pelikhan merged commit b8d76fb into main Oct 25, 2025
4 checks passed
@pelikhan pelikhan deleted the copilot/update-push-pull-request-tool branch October 25, 2025 15:09
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.

3 participants