Skip to content

docs: fix mcp list-tools example to use --server flag#38188

Merged
pelikhan merged 3 commits into
mainfrom
copilot/cli-consistency-fix-mcp-list-tools-usage
Jun 9, 2026
Merged

docs: fix mcp list-tools example to use --server flag#38188
pelikhan merged 3 commits into
mainfrom
copilot/cli-consistency-fix-mcp-list-tools-usage

Conversation

Copilot AI commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

The CLI docs showed <mcp-server> as a positional argument for mcp list-tools, but --server is a required flag and the only positional argument is an optional workflow name. Following the docs literally silently passes the server name as the workflow filter.

Changes

  • docs/src/content/docs/setup/cli.md: Replace the single incorrect example with two correct invocations:
# Before
gh aw mcp list-tools <mcp-server>          # List tools for server

# After
gh aw mcp list-tools --server github           # List tools for a server (all workflows)
gh aw mcp list-tools workflow --server github  # List tools for a server in a specific workflow

Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix CLI documentation for mcp list-tools command docs: fix mcp list-tools example to use --server flag Jun 9, 2026
Copilot AI requested a review from gh-aw-bot June 9, 2026 18:29
@pelikhan pelikhan marked this pull request as ready for review June 9, 2026 18:31
Copilot AI review requested due to automatic review settings June 9, 2026 18:31
@pelikhan pelikhan merged commit adb3c77 into main Jun 9, 2026
@pelikhan pelikhan deleted the copilot/cli-consistency-fix-mcp-list-tools-usage branch June 9, 2026 18:31

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the CLI documentation for gh aw mcp list-tools so the example usage matches the actual command syntax (required --server flag, optional workflow positional arg), preventing users from accidentally passing the server name as a workflow filter.

Changes:

  • Replace the incorrect mcp list-tools <mcp-server> example with two examples that use --server and demonstrate the optional workflow argument.
Show a summary per file
File Description
docs/src/content/docs/setup/cli.md Fixes mcp list-tools examples to use the required --server flag and show workflow-scoped usage

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 1

Comment on lines +723 to +724
gh aw mcp list-tools --server github # List tools for a server (all workflows)
gh aw mcp list-tools workflow --server github # List tools for a server in a specific workflow
github-actions Bot added a commit that referenced this pull request Jun 11, 2026
Closes issue #38126 follow-up items (M1-M7 medium and L1-L2, L4 low)
which were not addressed by PR #38188 (only fixed H1).

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
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] CLI Consistency Issues - 2026-06-09

4 participants