Skip to content

docs: Add missing mcp list-tools command to CLI reference#3729

Merged
pelikhan merged 2 commits intomainfrom
copilot/add-documentation-list-tools-command
Nov 12, 2025
Merged

docs: Add missing mcp list-tools command to CLI reference#3729
pelikhan merged 2 commits intomainfrom
copilot/add-documentation-list-tools-command

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Nov 12, 2025 •
edited
Loading

The gh aw mcp list-tools subcommand exists in the CLI but was undocumented in the reference guide, despite being used in other documentation guides.

Changes

  • Added mcp list-tools command documentation to docs/src/content/docs/setup/cli.md
  • Positioned between list and inspect commands for logical command flow

Documentation Added

gh aw mcp list-tools <mcp-server>          # List tools for specific MCP server
gh aw mcp list-tools <mcp-server> workflow # List tools in specific workflow

The command connects to an MCP server and displays available tools with their descriptions and allowance status, consistent with examples already present in web-search.md, mcps.md, and common-issues.md guides.

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Missing documentation for gh aw mcp list-tools subcommand</issue_title>
<issue_description>## Issue Description

Command: gh aw mcp list-tools
Type: Missing documentation
Priority: Medium

Current State

The mcp list-tools subcommand exists in the source code but is not documented in docs/src/content/docs/setup/cli.md.

Source Code Reference: pkg/cli/mcp_list_tools.go

Use:   "list-tools (mcp_server) [workflow-file]",
Short: "List available tools for a specific MCP server",

Documentation Location: docs/src/content/docs/setup/cli.md lines 304-308

Current Documentation

The MCP command section currently shows:

gh aw mcp list                             # List all MCP servers
gh aw mcp list workflow-name               # List servers for specific workflow
gh aw mcp inspect workflow-name            # Inspect and test servers
gh aw mcp add                              # Add servers from registry

Issue

The mcp list-tools subcommand is completely missing from the documentation, even though it's a functional command in the CLI.

Suggested Fix

Add the mcp list-tools subcommand to the documentation:

gh aw mcp list                             # List all MCP servers
gh aw mcp list workflow-name               # List servers for specific workflow
gh aw mcp list-tools (mcp-server)          # List tools for specific MCP server
gh aw mcp list-tools (mcp-server) workflow # List tools in specific workflow
gh aw mcp inspect workflow-name            # Inspect and test servers
gh aw mcp add                              # Add servers from registry

Impact

Users may not discover this useful command since it's not documented. This could lead to:

  • Reduced discoverability of MCP functionality
  • Users not knowing how to list available tools for MCP servers
  • Inconsistent documentation coverage

Additional Context

This command appears to be a core part of the MCP functionality and should be documented alongside the other MCP subcommands.

AI generated by CLI Consistency Checker</issue_description>

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.

@pelikhan
docs: Add missing mcp list-tools command to CLI documentation
539746c 
Add documentation for the `gh aw mcp list-tools` subcommand which was
previously undocumented. The command lists available tools for a specific
MCP server, optionally within a specific workflow context.

Fixes the documentation inconsistency where the command existed in the
CLI but was not listed in the reference documentation.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for gh aw mcp list-tools subcommand docs: Add missing mcp list-tools command to CLI reference Nov 12, 2025
Copilot AI requested a review from pelikhan November 12, 2025 14:45
@pelikhan pelikhan marked this pull request as ready for review November 12, 2025 14:49
Copilot AI review requested due to automatic review settings November 12, 2025 14:49
Copilot AI reviewed Nov 12, 2025
View reviewed changes
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 adds missing documentation for the gh aw mcp list-tools subcommand to the CLI reference guide. The command exists in the codebase and is already referenced in other documentation guides (web-search.md, mcps.md, common-issues.md) but was absent from the main CLI reference.

Key changes:

  • Added two command usage examples for mcp list-tools in the CLI reference documentation
  • Positioned the new documentation between existing mcp list and mcp inspect commands for logical grouping

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

docs/src/content/docs/setup/cli.md
gh aw mcp list # List all MCP servers
gh aw mcp list workflow-name # List servers for specific workflow
gh aw mcp list-tools <mcp-server> # List tools for specific MCP server
gh aw mcp list-tools <mcp-server> workflow # List tools in specific workflow
Copy link

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

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

The parameter format is inconsistent with the actual command implementation. According to the source code (mcp_list_tools.go line 231), the command signature is list-tools <mcp_server> [workflow-file], where the second parameter is [workflow-file] (a specific workflow filename), not just workflow. The documentation should use a more descriptive parameter name like <workflow-name> or <workflow-file> to match both the implementation and existing documentation examples in mcps.md (line 334: gh aw mcp list-tools notion my-workflow) and web-search.md (line 66: gh aw mcp list-tools tavily my-workflow --verbose).

Suggested change
gh aw mcp list-tools <mcp-server> workflow # List tools in specific workflow
gh aw mcp list-tools <mcp-server> <workflow-file> # List tools in specific workflow file

Copilot uses AI. Check for mistakes.
@pelikhan pelikhan merged commit 438fce7 into main Nov 12, 2025
78 checks passed
@pelikhan pelikhan deleted the copilot/add-documentation-list-tools-command branch November 12, 2025 14:53
Copilot AI mentioned this pull request Nov 12, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

+1 more reviewer

@pelikhan pelikhan pelikhan approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@pelikhan pelikhan

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[cli-consistency] Missing documentation for gh aw mcp list-tools subcommand

3 participants

@pelikhan