Add args support for github and playwright tools in frontmatter by Copilot · Pull Request #1130 · github/gh-aw

Copilot · 2025-10-01T15:30:55Z

Summary: Add args support for github and playwright tools ✅

This PR successfully adds support for optional "args" argument for github and playwright tools in the frontmatter, allowing users to customize MCP server behavior.

Changes completed:

Implementation details:

Helper functions (pkg/workflow/args.go):
- extractCustomArgs() - Generic extraction helper for tool args
- getGitHubCustomArgs() - Extracts custom args from GitHub tool config
- getPlaywrightCustomArgs() - Extracts custom args from Playwright tool config
- writeArgsToYAML() - Writes args to YAML with proper JSON quoting (multi-line)
- writeArgsToYAMLInline() - Writes args to YAML inline (single-line format)
- All functions properly handle []any and []string formats
- Use json.Marshal for proper quoting and escaping
Parser updates (pkg/parser/mcp.go):
- Extended processBuiltinMCPTool() to append custom args after default args
- Args are appended to the Args slice for both github and playwright tools
Engine renderer updates:
- All four engines (Custom, Copilot, Claude, Codex) now use centralized helpers
- Args are properly quoted and escaped using helper functions
- Removed duplicate json imports where no longer needed
Schema updates (pkg/parser/schemas/main_workflow_schema.json):
- Added args field definition for both github and playwright tools
- Field is optional array of strings with descriptive documentation
Validation fix (pkg/workflow/mcp-config.go):
- Excluded args from MCP-defining fields in getRawMCPConfig()
- This prevents built-in tools from being incorrectly treated as custom MCP tools
- Added comprehensive comments explaining the consequences
Comprehensive tests (pkg/workflow/args_field_test.go):
- 5 test cases covering extraction, parser integration, and combined usage
- Validates args work correctly with version field
- All tests passing ✅
Documentation:
- Updated docs/src/content/docs/reference/tools.md with detailed args configuration examples
- Updated .github/instructions/github-agentic-workflows.instructions.md with args usage patterns
- Added examples for GitHub and Playwright tools
- Documented common use cases (debugging flags, testing scenarios)
- Noted special character escaping behavior
- Clarified that only Chromium browser is supported
Test Workflows:
- pkg/cli/workflows/test-github-args.md - Demonstrates GitHub tool args with --verbose flag
- pkg/cli/workflows/test-playwright-args.md - Demonstrates Playwright args with browser selection
- pkg/cli/workflows/test-args-special-chars.md - Tests special character escaping (spaces, key=value formats)
- All test workflows compile successfully and generate proper MCP configurations

Code Organization:

Created new pkg/workflow/args.go file with all args-related helper functions
Removed duplicate extraction logic from pkg/workflow/mcps.go
Centralized YAML writing logic with proper quoting in helper functions
Cleaner, more maintainable codebase with single source of truth for args handling

Test results:

✅ All unit tests passing (3.6s)
✅ Build successful
✅ Linting passed
✅ All 47 workflow files compiled successfully (including new test workflows)
✅ Special character escaping verified
✅ Code review addressed
✅ Documentation complete
✅ Test workflows validated

Usage example:

---
on: workflow_dispatch
engine: claude
tools:
  github:
    version: "v2.0.0"
    args: ["--custom-flag", "--verbose"]
  playwright:
    allowed_domains: ["example.com"]
    args: ["--browser", "chromium"]
---

# My Workflow
The custom args will be appended to the MCP server commands with proper escaping.

Documentation and Examples:

Users can reference:

Tools Reference: docs/src/content/docs/reference/tools.md - Detailed args configuration guide
Instructions: .github/instructions/github-agentic-workflows.instructions.md - Args usage patterns
Test Workflows: pkg/cli/workflows/test-*-args.md - Working examples demonstrating various args configurations

Original prompt

Add support for optimal "args" argument for github and playwright tools in the frontmatter.

The args is a string array and gets appended to the generated command in the MCP server configuration file if present.

This argument allows further customizations of the behavior of those MCPs.

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

pelikhan · 2025-10-01T15:53:13Z

@copilot use proper quoting when generating the yaml with args. Look for existing helpers or use Go quoted string format support.

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

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

pelikhan · 2025-10-01T16:14:38Z


+// getPlaywrightCustomArgs extracts custom args from Playwright tool configuration
+func getPlaywrightCustomArgs(playwrightTool any) []string {
+	if toolConfig, ok := playwrightTool.(map[string]any); ok {


@copilot create helper function to extract args, move to args.go

Created pkg/workflow/args.go with helper function extractCustomArgs() that consolidates the extraction logic. Moved getGitHubCustomArgs() and getPlaywrightCustomArgs() to use this shared helper (commit 157012c).

pelikhan · 2025-10-01T16:14:47Z


+// getGitHubCustomArgs extracts custom args from GitHub tool configuration
+func getGitHubCustomArgs(githubTool any) []string {
+	if toolConfig, ok := githubTool.(map[string]any); ok {


@copilot use custom helper

Updated to use extractCustomArgs() helper function from args.go (commit 157012c).

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

Copilot · 2025-10-01T16:16:45Z

@copilot use proper quoting when generating the yaml with args. Look for existing helpers or use Go quoted string format support.

Updated to use json.Marshal for proper quoting and escaping of args in all engine renderers (commit 58cf0fe). This handles special characters including spaces, quotes, backslashes, tabs, and newlines correctly.

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

pelikhan · 2025-10-01T16:33:54Z

@copilot

update documentation
add test agentic workflows for these features

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

pelikhan · 2025-10-01T16:44:13Z

@copilot only chromium available in headless mode, do not use in documentation samples

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

Copilot · 2025-10-01T16:44:43Z

@copilot

update documentation
...

Added documentation and test workflows (commits 0533fd8, 5b081a7):

Documentation:

Updated docs/src/content/docs/reference/tools.md with args examples for GitHub and Playwright
Updated .github/instructions/github-agentic-workflows.instructions.md with args usage patterns

Test Workflows:

test-github-args.md - Tests GitHub tool args with --verbose flag
test-playwright-args.md - Tests Playwright args with --browser chromium
test-args-special-chars.md - Tests special character escaping (spaces, key=value)

All workflows compile successfully and generate proper MCP configurations with escaped args.

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

Copilot · 2025-10-01T16:50:08Z

@copilot only chromium available in headless mode, do not use in documentation samples

Removed --headless flag from documentation examples and added note clarifying that only Chromium is available in headless mode (commit 8f7b644).

pelikhan · 2025-10-01T16:59:42Z

  playwright:
    version: "latest"                    # Optional: Playwright version
    allowed_domains: ["defaults", "github", "*.custom.com"]  # Domain access control
+    args: ["--browser", "firefox"]      # Optional: additional command-line arguments


@copilot remove this line

Removed the args line from Playwright Configuration Options section (commit 5ac2a96).

pelikhan · 2025-10-01T17:01:11Z

+- Browser selection: `["--browser", "firefox"]` or `["--browser", "chromium"]`
+- Custom flags for debugging or testing scenarios
+
+**Note**: Only Chromium is available in headless mode.


@copilot remove mention of choosing browser, only chromium is supported

Removed browser selection examples and updated note to clarify that only Chromium browser is supported (commit 5ac2a96).

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

Initial plan

c04d64e

Copilot AI assigned Copilot and pelikhan Oct 1, 2025

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

Add args support for github and playwright tools in frontmatter

9d7faab

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

Copilot AI and others added 2 commits October 1, 2025 16:02

Update schema and validation to support args field for github and pla…

be0c85c

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

Improve comments based on code review feedback

61142f7

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

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

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

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

pelikhan reviewed Oct 1, 2025

View reviewed changes

Comment thread pkg/workflow/custom_engine.go Outdated

Use json.Marshal for proper quoting and escaping of args in YAML gene…

58cf0fe

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

Copilot AI requested a review from pelikhan October 1, 2025 16:17

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

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

Refactor args extraction and writing to dedicated args.go file with h…

157012c

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

Copilot finished work on behalf of pelikhan October 1, 2025 16:28

pelikhan marked this pull request as ready for review October 1, 2025 16:31

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

Add documentation and test workflows for args feature

0533fd8

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

Update instructions file with args documentation

5b081a7

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

Copilot finished work on behalf of pelikhan October 1, 2025 16:45

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

Remove --headless flag from Playwright args documentation examples

8f7b644

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

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

pelikhan reviewed Oct 1, 2025

View reviewed changes

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

Remove browser selection examples and clarify Chromium-only support

5ac2a96

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

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

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

pelikhan merged commit 31ece23 into main Oct 1, 2025

pelikhan deleted the copilot/fix-029c513d-394a-4ff4-ae62-eea332504e83 branch October 1, 2025 18:11

Conversation

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

Uh oh!

Summary: Add args support for github and playwright tools ✅

Changes completed:

Implementation details:

Code Organization:

Test results:

Usage example:

Documentation and Examples:

Uh oh!

pelikhan 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 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!

Uh oh!

Copilot AI commented Oct 1, 2025

Uh oh!

pelikhan commented Oct 1, 2025

Uh oh!

pelikhan commented Oct 1, 2025

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

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Oct 1, 2025 •

edited

Loading