Skip to content

Commit 7bf0a0f

Browse files
committed
gh aw inspect --> gh aw mcp-inspect
1 parent 347a39b commit 7bf0a0f

9 files changed

Lines changed: 39 additions & 40 deletions

File tree

cmd/gh-aw/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ func init() {
353353
rootCmd.AddCommand(enableCmd)
354354
rootCmd.AddCommand(disableCmd)
355355
rootCmd.AddCommand(cli.NewLogsCommand())
356-
rootCmd.AddCommand(cli.NewInspectCommand())
356+
rootCmd.AddCommand(cli.NewMCPInspectCommand())
357357
rootCmd.AddCommand(versionCmd)
358358
}
359359

docs/commands.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -191,28 +191,28 @@ gh aw logs --format json -o ./exports/
191191

192192
## 🔍 MCP Server Inspection
193193

194-
The `inspect` command allows you to analyze and troubleshoot Model Context Protocol (MCP) servers configured in your workflows.
194+
The `mcp-inspect` command allows you to analyze and troubleshoot Model Context Protocol (MCP) servers configured in your workflows.
195195

196196
> **📘 Complete MCP Guide**: For comprehensive MCP setup, configuration examples, and troubleshooting, see the [MCPs](mcps.md).
197197
198198
```bash
199199
# List all workflows that contain MCP server configurations
200-
gh aw inspect
200+
gh aw mcp-inspect
201201

202202
# Inspect all MCP servers in a specific workflow
203-
gh aw inspect workflow-name
203+
gh aw mcp-inspect workflow-name
204204

205205
# Filter inspection to specific servers by name
206-
gh aw inspect workflow-name --server server-name
206+
gh aw mcp-inspect workflow-name --server server-name
207207

208208
# Show detailed information about a specific tool (requires --server)
209-
gh aw inspect workflow-name --server server-name --tool tool-name
209+
gh aw mcp-inspect workflow-name --server server-name --tool tool-name
210210

211211
# Enable verbose output with connection details
212-
gh aw inspect workflow-name --verbose
212+
gh aw mcp-inspect workflow-name --verbose
213213

214214
# Launch the official @modelcontextprotocol/inspector web interface
215-
gh aw inspect workflow-name --inspector
215+
gh aw mcp-inspect workflow-name --inspector
216216
```
217217

218218
**Key Features:**

docs/mcps.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ tools:
3838

3939
> [!TIP]
4040
> You can inspect test your MCP configuration by running <br/>
41-
> `gh aw inspect <workflow-file>`
41+
> `gh aw mcp-inspect <workflow-file>`
4242
4343

4444
### Engine Compatibility
@@ -165,7 +165,7 @@ When using an agentic engine that allows tool whitelisting (e.g. Claude), this g
165165

166166
> [!TIP]
167167
> You can inspect the tools available for an Agentic Workflow by running <br/>
168-
> `gh aw inspect <workflow-file>`
168+
> `gh aw mcp-inspect <workflow-file>`
169169

170170
### Wildcard Access
171171

@@ -198,24 +198,23 @@ tools:
198198

199199
### MCP Server Inspection
200200

201-
Use the `inspect` command to analyze and troubleshoot MCP configurations:
201+
Use the `mcp-inspect` command to analyze and troubleshoot MCP configurations:
202202

203203
```bash
204-
# List all workflows with MCP configurations
205-
gh aw inspect
204+
# List all workflows with MCP servers configured
205+
gh aw mcp-inspect
206206
207207
# Inspect all MCP servers in a specific workflow
208-
gh aw inspect my-workflow
208+
gh aw mcp-inspect my-workflow
209209
210-
# Filter to specific servers
211-
gh aw inspect my-workflow --server trello-server
210+
# Inspect a specific MCP server in a workflow
211+
gh aw mcp-inspect my-workflow --server trello-server
212212
213-
# Verbose output with connection details
214-
gh aw inspect my-workflow --verbose
213+
# Enable verbose output for debugging connection issues
214+
gh aw mcp-inspect my-workflow --verbose
215215
216216
# Launch official MCP inspector web interface
217-
gh aw inspect my-workflow --inspector
218-
```
217+
gh aw mcp-inspect my-workflow --inspector
219218
220219
### Common Issues and Solutions
221220
@@ -241,13 +240,13 @@ Error: Tool 'my_tool' not found
241240
242241
**Solutions**:
243242
1. Add tool to `allowed` list
244-
2. Check tool name spelling (use `gh aw inspect` to see available tools)
243+
2. Check tool name spelling (use `gh aw mcp-inspect` to see available tools)
245244
3. Verify MCP server is running correctly
246245

247246
## Related Documentation
248247

249248
- [Tools Configuration](tools.md) - Complete tools reference
250-
- [Commands](commands.md) - CLI commands including `inspect`
249+
- [Commands](commands.md) - CLI commands including `mcp-inspect`
251250
- [Include Directives](include-directives.md) - Modularizing workflows with includes
252251
- [Secrets Management](secrets.md) - Managing secrets and environment variables
253252
- [Frontmatter Options](frontmatter.md) - All configuration options

docs/tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ All tools declared in included components are merged into the final workflow.
2222
2323
> [!TIP]
2424
> You can inspect the tools available for an Agentic Workflow by running <br/>
25-
> `gh aw inspect <workflow-file>`
25+
> `gh aw mcp-inspect <workflow-file>`
2626

2727
## GitHub Tools (`github:`)
2828

docs/tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ gh aw logs weekly-research
9292

9393
- `gh aw status` — Check workflow installation status
9494
- `gh aw logs` — Download recent run logs and cost/usage analysis
95-
- `gh aw inspect` — Inspect MCP servers and tools
95+
- `gh aw mcp-inspect` — Inspect MCP servers and tools
9696
- If compilation fails, run `gh aw compile --verbose` for more details and follow the error output.
9797

9898
### What's next?
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -184,32 +184,32 @@ func listWorkflowsWithMCP(workflowsDir string, verbose bool) error {
184184
for _, workflow := range workflowsWithMCP {
185185
fmt.Printf(" • %s\n", workflow)
186186
}
187-
fmt.Printf("\nRun 'gh aw inspect <workflow-name>' to inspect MCP servers in a specific workflow.\n")
187+
fmt.Printf("\nRun 'gh aw mcp-inspect <workflow-name>' to inspect MCP servers in a specific workflow.\n")
188188

189189
return nil
190190
}
191191

192-
// NewInspectCommand creates the inspect command
193-
func NewInspectCommand() *cobra.Command {
192+
// NewMCPInspectCommand creates the mcp-inspect command
193+
func NewMCPInspectCommand() *cobra.Command {
194194
var serverFilter string
195195
var toolFilter string
196196
var spawnInspector bool
197197

198198
cmd := &cobra.Command{
199-
Use: "inspect [workflow-file]",
199+
Use: "mcp-inspect [workflow-file]",
200200
Short: "Inspect MCP servers and list available tools, resources, and roots",
201201
Long: `Inspect MCP servers used by a workflow and display available tools, resources, and roots.
202202
203203
This command starts each MCP server configured in the workflow, queries its capabilities,
204204
and displays the results in a formatted table. It supports stdio, Docker, and HTTP MCP servers.
205205
206206
Examples:
207-
gh aw inspect # List workflows with MCP servers
208-
gh aw inspect weekly-research # Inspect MCP servers in weekly-research.md
209-
gh aw inspect repomind --server repo-mind # Inspect only the repo-mind server
210-
gh aw inspect weekly-research --server github --tool create_issue # Show details for a specific tool
211-
gh aw inspect weekly-research -v # Verbose output with detailed connection info
212-
gh aw inspect weekly-research --inspector # Launch @modelcontextprotocol/inspector
207+
gh aw mcp-inspect # List workflows with MCP servers
208+
gh aw mcp-inspect weekly-research # Inspect MCP servers in weekly-research.md
209+
gh aw mcp-inspect repomind --server repo-mind # Inspect only the repo-mind server
210+
gh aw mcp-inspect weekly-research --server github --tool create_issue # Show details for a specific tool
211+
gh aw mcp-inspect weekly-research -v # Verbose output with detailed connection info
212+
gh aw mcp-inspect weekly-research --inspector # Launch @modelcontextprotocol/inspector
213213
214214
The command will:
215215
- Parse the workflow file to extract MCP server configurations

pkg/cli/templates/instructions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -678,23 +678,23 @@ permissions:
678678

679679
### MCP Server Inspection
680680

681-
Use the `inspect` command to analyze and debug MCP servers in workflows:
681+
Use the `mcp-inspect` command to analyze and debug MCP servers in workflows:
682682

683683
```bash
684684
# List workflows with MCP configurations
685-
gh aw inspect
685+
gh aw mcp-inspect
686686
687687
# Inspect MCP servers in a specific workflow
688-
gh aw inspect workflow-name
688+
gh aw mcp-inspect workflow-name
689689
690690
# Filter to a specific MCP server
691-
gh aw inspect workflow-name --server server-name
691+
gh aw mcp-inspect workflow-name --server server-name
692692
693693
# Show detailed information about a specific tool
694-
gh aw inspect workflow-name --server server-name --tool tool-name
694+
gh aw mcp-inspect workflow-name --server server-name --tool tool-name
695695
696696
# Enable verbose output with connection details
697-
gh aw inspect workflow-name --verbose
697+
gh aw mcp-inspect workflow-name --verbose
698698
```
699699

700700
The `--tool` flag provides detailed information about a specific tool, including:

0 commit comments

Comments
 (0)