Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 24, 2025

The mcp-server command had minimal examples compared to other CLI commands (logs, audit, trial), lacking context about when to use different transport modes and debugging options.

Changes

  • Added contextual descriptions to existing examples explaining stdio vs HTTP transport modes
  • Added DEBUG environment variable example for verbose logging during troubleshooting
  • Improved formatting and alignment for consistency with other commands

Before/After

 Examples:
-  gh aw mcp-server              # Run with stdio transport
-  gh aw mcp-server --port 8080  # Run HTTP server on port 8080
-  gh aw mcp-server --cmd ./gh-aw # Use custom gh-aw binary
+  gh aw mcp-server                    # Run with stdio transport (default for MCP clients)
+  gh aw mcp-server --port 8080        # Run HTTP server on port 8080 (for web-based clients)
+  gh aw mcp-server --cmd ./gh-aw      # Use custom gh-aw binary path
+  DEBUG=mcp:* gh aw mcp-server        # Run with verbose logging for debugging

The examples now provide actionable context for users choosing between transport modes and debugging server issues.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/user
    • Triggering command: /usr/bin/gh gh api user --jq .login rite '../../**/*GOINSECURE git 64/bin/go /home/REDACTED/worgo rev-parse /usr/bin/git /opt/hostedtoolcGO111MODULE ache�� 64/pkg/tool/linuGOINSECURE git 64/bin/go ons-test14867011/home/REDACTED/.cache/go-build/10/1001a8fc44d1698343ad04fae260805c14ef35c9051932dd34a412a317e0b47a-d/gh-aw config modules/@npmcli/GOPATH ache/go/1.25.0/xGOPROXY (http block)
    • Triggering command: /usr/bin/gh gh api user --jq .login ithub/workflows GOPROXY /bin/sh GOSUMDB GOWORK 34a412a317e0b47a/tmp/gh-aw-test-runs/20251224-230440-22594/test-244500065 /bin/sh -c b/workflows 34a412a317e0b47a-d/gh-aw /usr/bin/git l Add comprehensivapi ache/node/24.12.user git (http block)
    • Triggering command: /usr/bin/gh gh api user --jq .login 9/parse_claude_log.js -trimpath /usr/bin/git -p main -lang=go1.25 git -C ithub/workflows config /usr/bin/git l -c=4 -nolocalimports git (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Missing examples in mcp-server command help text</issue_title>
<issue_description>## Issue Description

Command: gh aw mcp-server
Type: Missing examples
Priority: Medium

Current Output (from pkg/cli/mcp_server.go, lines 24-56)

The command has a comprehensive Long description explaining what the MCP server does and what tools it provides. However, compared to other commands like logs, audit, compile, etc., it has minimal examples:

Examples:
  gh aw mcp-server              # Run with stdio transport
  gh aw mcp-server --port 8080  # Run HTTP server on port 8080
  gh aw mcp-server --cmd ./gh-aw # Use custom gh-aw binary

Issue

Most other commands in the CLI have more comprehensive examples showing:

  1. Basic usage
  2. Common options combinations
  3. Use cases with context

The mcp-server command examples are functional but could benefit from:

  • Examples showing how to test the server
  • Examples of connecting to the server from a client
  • Examples showing when to use stdio vs HTTP mode

Suggested Fix

Add more contextual examples such as:

Examples:
  gh aw mcp-server                    # Run with stdio transport (default for MCP clients)
  gh aw mcp-server --port 8080        # Run HTTP server on port 8080 (for web-based clients)
  gh aw mcp-server --cmd ./gh-aw      # Use custom gh-aw binary path
  gh aw mcp-server -v                 # Run with verbose logging for debugging

This would align with the example patterns used in commands like logs (100+ lines of examples), compile (20+ lines), and trial (80+ lines).

AI generated by CLI Consistency Checker

Comments on the Issue (you are @copilot in this section)


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

- Added contextual descriptions to existing examples (stdio transport, HTTP server, custom binary)
- Added new example showing DEBUG environment variable for verbose logging
- Aligned with example patterns used in other commands (logs, audit, trial)
- Examples now clearly explain when to use stdio vs HTTP mode

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Add comprehensive examples to mcp-server command help text Add comprehensive examples to mcp-server command help text Dec 24, 2025
Copilot AI requested a review from mnkiefer December 24, 2025 23:11
@pelikhan pelikhan marked this pull request as ready for review December 24, 2025 23:41
@pelikhan pelikhan merged commit 2eebf40 into main Dec 24, 2025
4 checks passed
@pelikhan pelikhan deleted the copilot/add-examples-to-mcp-server-help branch December 24, 2025 23:41
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.

[cli-consistency] Missing examples in mcp-server command help text

3 participants