Fix Copilot engine to generate --allow-tool arguments for GitHub MCP tools by Copilot · Pull Request #1115 · github/gh-aw

Copilot · 2025-09-30T17:02:29Z

Fix Copilot Engine GitHub Tool Allow-List Generation

The Copilot agentic engine was not generating --allow-tool arguments for GitHub MCP tools correctly. This caused GitHub API operations to fail during workflow execution.

Problem Analysis

GitHub is NOT built-in to Copilot CLI in non-interactive (CLI) mode - it requires MCP configuration
The GitHub MCP server should only be allowed via --allow-tool github when using wildcard "*"
Individual GitHub tools need to be allowed via --allow-tool github(tool_name)
The code was incorrectly treating GitHub as built-in and skipping it entirely in the builtInTools map
Default GitHub tools are added by applyDefaultTools and need to be converted to --allow-tool arguments

Solution

Modified computeCopilotToolArguments in pkg/workflow/copilot_engine.go to handle GitHub as an MCP server tool with conditional server-level permission:

Removed GitHub from builtInTools list: GitHub is not built-in in CLI mode (only in interactive mode)
Added special handling for GitHub: Treat it as an MCP server tool with conditional behavior
Efficient single-pass processing: Process the allowed array once to detect wildcard and add tool permissions
Conditional server-level permission:
- Only emit --allow-tool github when allowed contains "*" wildcard
- Always emit --allow-tool github(tool_name) for each specific tool (excluding wildcard)
Maintain sorted output: Tool arguments are alphabetically sorted for consistency
Proper shell escaping: Arguments with special characters (like parentheses) are automatically wrapped in single quotes via shellEscapeArg function

Before

copilot --add-dir /tmp/ --log-level all --prompt "$INSTRUCTION"

After (with specific tools)

copilot --add-dir /tmp/ --log-level all \
  --allow-tool 'github(get_issue)' \
  --allow-tool 'github(add_issue_comment)' \
  --allow-tool 'github(list_issues)' \
  --prompt "$INSTRUCTION"

After (with wildcard)

copilot --add-dir /tmp/ --log-level all \
  --allow-tool github \
  --prompt "$INSTRUCTION"

After (GitHub not configured)

copilot --add-dir /tmp/ --log-level all \
  --prompt "$INSTRUCTION"

Testing

Updated 8 test cases to remove --allow-tool github when not using wildcard
Added 2 new test cases for wildcard behavior (wildcard-only and wildcard with specific tools)
Added explicit test for shell escaping of GitHub tool arguments
All existing tests continue to pass
Manually verified the generated Copilot commands include correct tool arguments with proper single-quote wrapping
Verified no arguments are added when GitHub is not configured

Changes

pkg/workflow/copilot_engine.go: Simplified wildcard handling with single-pass processing, only emit server-level permission with wildcard
pkg/workflow/copilot_engine_test.go: Updated comprehensive test cases including wildcard scenarios
pkg/workflow/shell.go: Existing shell escaping logic handles parentheses correctly

Original prompt

Make sure the copilot agentic engine generates the --allow-tool list for the github mcp. Although it is a builtin, the tool have to be allowed to.

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

…fe01

pelikhan · 2025-10-01T05:05:53Z

@copilot use "--deny-tool github" when GitHub is disabled

- Modified computeCopilotToolArguments to add --deny-tool github for empty allowed arrays, nil, false values - Updated sorting logic to preserve flag types (--allow-tool vs --deny-tool) - Modified applyDefaultTools to respect explicitly empty allowed arrays - Added test case for github: false - Updated tests to expect --deny-tool github for disabled cases Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2025-10-01T05:16:43Z

@copilot use "--deny-tool github" when GitHub is disabled

Added --deny-tool github support in commit e322c1a.

When GitHub is disabled (empty allowed array, nil, or false), the Copilot CLI command now includes --deny-tool github. For example:

copilot --deny-tool github --prompt "$INSTRUCTION"

The compiler also now respects explicitly empty allowed arrays (github: { allowed: [] }), which allows users to disable GitHub tools without having defaults added automatically.

…fe01

pelikhan · 2025-10-01T06:43:09Z

@copilot remove --deny-tool support since github is only enabled on demand.

… readability

Copilot · 2025-10-01T06:49:20Z

@copilot remove --deny-tool support since github is only enabled on demand.

Removed --deny-tool support in commit 99c1a9e.

GitHub is now only enabled on demand when explicitly configured with tools. When GitHub is not configured or has an empty allowed array, no arguments are added to the Copilot CLI command. This is the correct behavior since GitHub is a built-in tool that doesn't need to be explicitly denied.

pelikhan

@copilot remove the --deny-tool support

pelikhan

@copilot the entries like

github(add_issue_comment)"

must be single quoted:

'github(add_issue_comment)'

Reverted all --deny-tool logic since GitHub is only enabled on demand: - Simplified GitHub handling in copilotengine.go to only add --allow-tool for configured tools - Reverted sorting logic to simpler version that assumes all flags are --allow-tool - Reverted compiler changes to always add default GitHub tools - Updated test expectations to not expect --deny-tool Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2025-10-01T07:05:43Z

@copilot remove the --deny-tool support

Removed all --deny-tool support in commit 65fde01.

The code now only adds --allow-tool github(tool_name) when GitHub tools are explicitly configured. When GitHub is not configured or has an empty allowed array, no arguments are added since GitHub is only enabled on demand.

Added TestCopilotEngineGitHubToolsShellEscaping to explicitly verify that GitHub tool arguments like 'github(add_issue_comment)' are properly wrapped in single quotes by the shellEscapeArg function. Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2025-10-01T07:14:49Z

@copilot the entries like
github(add_issue_comment)" ...

The GitHub tool arguments are already being single-quoted correctly. The shellEscapeArg function in pkg/workflow/shell.go automatically wraps arguments containing parentheses in single quotes.

Added test TestCopilotEngineGitHubToolsShellEscaping in commit 39676d0 to explicitly verify this behavior. The test confirms that arguments like 'github(add_issue_comment)' and 'github(get_issue)' are properly single-quoted in the generated commands.

Example from a compiled workflow:

copilot --allow-tool 'github(get_issue)' --allow-tool 'github(add_issue_comment)'

pelikhan · 2025-10-01T07:23:28Z

+	// Handle GitHub MCP tools - GitHub is built-in to Copilot CLI but still needs tool allowlist
+	if githubConfig, hasGithub := tools["github"]; hasGithub {
+		if githubConfigMap, ok := githubConfig.(map[string]any); ok {
+			// GitHub is built-in, so we don't add --allow-tool github itself


@copilot GitHub is not builtin in cli mode (only interactive mode) so you need to treat like any other tool and emit the proper arguments.

Updated in commit ee6281c to treat GitHub as an MCP server tool in CLI mode.

Now emits both:

--allow-tool github (the MCP server itself)

--allow-tool 'github(tool_name)' for each allowed tool

Example generated command:

copilot --allow-tool github --allow-tool 'github(get_issue)' --allow-tool 'github(add_issue_comment)'

GitHub is not built-in in CLI mode (only in interactive mode), so it needs to be treated like any other MCP server tool. Updated to: - Remove GitHub from builtInTools list - Add special handling for GitHub in MCP server loop - Emit both --allow-tool github and --allow-tool github(tool_name) for each allowed tool - Updated tests to expect --allow-tool github in addition to individual tool permissions Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

pelikhan · 2025-10-01T14:16:51Z

@copilot only add --allow-tool GitHub when allowed is "*"

Modified GitHub handling to only emit --allow-tool github (server-level permission) when the allowed array contains the "*" wildcard. When specific tools are listed, only emit --allow-tool github(tool_name) for each tool. This allows more granular control - users can specify just the tools they need without enabling the entire GitHub MCP server. Updated tests to: - Remove --allow-tool github from tests with specific tools - Add new test cases for wildcard behavior - Add test for wildcard combined with specific tools Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2025-10-01T14:21:34Z

@copilot only add --allow-tool GitHub when allowed is "*"

Updated in commit 565ca88 to only add --allow-tool github when the allowed array contains "*".

When specific tools are listed, only the individual tool permissions are emitted:

copilot --allow-tool 'github(get_issue)' --allow-tool 'github(add_issue_comment)'

When wildcard is used:

copilot --allow-tool github

pelikhan · 2025-10-01T14:28:54Z

@copilot review the wildcard treatment and make sure you are not tearing it twice. Simplify, add test cases

Refactored GitHub tool handling to process the allowed array only once instead of twice: - Single loop processes both wildcard detection and individual tool permissions - Wildcard "*" adds server-level permission (--allow-tool github) - Other tools add individual permissions (--allow-tool github(tool_name)) - More efficient and easier to understand All existing tests pass without changes. Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2025-10-01T14:37:23Z

@copilot review the wildcard treatment and make sure you are not tearing it twice. Simplify, add test cases

Simplified in commit 488ddd3 to process the allowed list in a single pass instead of iterating twice.

The refactored code:

Processes wildcard detection and individual tool permissions in one loop
More efficient and easier to understand
All existing tests pass without changes

Initial plan

3a5eadf

Copilot AI assigned Copilot and pelikhan Sep 30, 2025

Copilot started work on behalf of pelikhan September 30, 2025 17:03 View session

Copilot AI and others added 2 commits September 30, 2025 17:08

Add GitHub tool allow-list generation for Copilot engine

f6bcf2b

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Recompile workflows with GitHub tool allow-list

c1bd482

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Make sure the copilot agentic engine generates the --allow-tool list for the github mcp. Although it is a builtin, the tool have to be allowed to.~~ Fix Copilot engine to generate --allow-tool arguments for GitHub MCP tools Sep 30, 2025

Copilot AI requested a review from pelikhan September 30, 2025 17:17

Copilot finished work on behalf of pelikhan September 30, 2025 17:17

pelikhan marked this pull request as ready for review September 30, 2025 17:20

Merge branch 'main' into copilot/fix-2b52337f-e29b-49f5-90fa-e39324a0…

10a94e0

…fe01

Copilot started work on behalf of pelikhan October 1, 2025 05:06 View session

Copilot AI changed the title ~~Fix Copilot engine to generate --allow-tool arguments for GitHub MCP tools~~ Fix Copilot engine to generate --allow-tool and --deny-tool arguments for GitHub MCP tools Oct 1, 2025

Copilot finished work on behalf of pelikhan October 1, 2025 05:17

pelikhan added 2 commits September 30, 2025 23:28

Merge branch 'main' into copilot/fix-2b52337f-e29b-49f5-90fa-e39324a0…

8882171

…fe01

Merge branch 'main' into copilot/fix-2b52337f-e29b-49f5-90fa-e39324a0…

316db64

…fe01

Copilot started work on behalf of pelikhan October 1, 2025 06:43 View session

Refactor argument sorting in computeCopilotToolArguments for improved…

c1d494f

… readability

Copilot AI changed the title ~~Fix Copilot engine to generate --allow-tool and --deny-tool arguments for GitHub MCP tools~~ Fix Copilot engine to generate --allow-tool arguments for GitHub MCP tools Oct 1, 2025

Copilot finished work on behalf of pelikhan October 1, 2025 06:50

pelikhan reviewed Oct 1, 2025

View reviewed changes

Copilot started work on behalf of pelikhan October 1, 2025 06:59 View session

pelikhan reviewed Oct 1, 2025

View reviewed changes

Copilot AI requested a review from pelikhan October 1, 2025 07:06

Copilot finished work on behalf of pelikhan October 1, 2025 07:06

Copilot started work on behalf of pelikhan October 1, 2025 07:07 View session

Copilot finished work on behalf of pelikhan October 1, 2025 07:15

pelikhan reviewed Oct 1, 2025

View reviewed changes

Copilot started work on behalf of pelikhan October 1, 2025 07:29 View session

Copilot AI changed the title ~~Fix Copilot engine to generate --allow-tool arguments for GitHub MCP tools~~ Fix Copilot engine to generate --allow-tool arguments for GitHub MCP server and tools Oct 1, 2025

Copilot finished work on behalf of pelikhan October 1, 2025 07:38

Copilot AI requested a review from pelikhan October 1, 2025 07:38

Copilot started work on behalf of pelikhan October 1, 2025 14:17 View session

Copilot AI changed the title ~~Fix Copilot engine to generate --allow-tool arguments for GitHub MCP server and tools~~ Fix Copilot engine to generate --allow-tool arguments for GitHub MCP tools Oct 1, 2025

Copilot finished work on behalf of pelikhan October 1, 2025 14:22

Copilot started work on behalf of pelikhan October 1, 2025 14:29 View session

Copilot finished work on behalf of pelikhan October 1, 2025 14:38

pelikhan merged commit a01a702 into main Oct 1, 2025
7 of 11 checks passed

pelikhan deleted the copilot/fix-2b52337f-e29b-49f5-90fa-e39324a0fe01 branch October 1, 2025 14:41

Conversation

Copilot AI commented Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fix Copilot Engine GitHub Tool Allow-List Generation

Problem Analysis

Solution

Before

After (with specific tools)

After (with wildcard)

After (GitHub not configured)

Testing

Changes

Uh oh!

pelikhan commented Oct 1, 2025

Uh oh!

Copilot AI commented Oct 1, 2025

Uh oh!

pelikhan commented Oct 1, 2025

Uh oh!

Copilot AI commented Oct 1, 2025

Uh oh!

pelikhan left a comment

Choose a reason for hiding this comment

Uh oh!

pelikhan left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Oct 1, 2025

Uh oh!

Copilot AI commented Oct 1, 2025

Uh oh!

pelikhan Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

pelikhan commented Oct 1, 2025

Uh oh!

Copilot AI commented Oct 1, 2025

Uh oh!

pelikhan commented Oct 1, 2025

Uh oh!

Copilot AI commented Oct 1, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Sep 30, 2025 •

edited

Loading