Skip to content

Add console error formatting to MCP CLI commands #11606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 3 commits into from
Jan 24, 2026
Merged

Add console error formatting to MCP CLI commands #11606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c148890
Initial plan
Copilot Jan 24, 2026
f546d77
Add console error formatting to MCP validation files (part 1)
Copilot Jan 24, 2026
f791c9f
Fix: Remove console formatting from validation library (keep only CLI…
Copilot Jan 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions pkg/cli/mcp_inspect.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ func applyImportsToFrontmatter(frontmatter map[string]any, importsResult *parser
compiler := workflow.NewCompiler(false, "", "")
mergedMCPServers, err := compiler.MergeMCPServers(existingMCPServers, importsResult.MergedMCPServers)
if err != nil {
errMsg := fmt.Sprintf("failed to merge imported MCP servers: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return nil, fmt.Errorf("failed to merge imported MCP servers: %w", err)
}

Expand All @@ -93,6 +95,8 @@ func applyImportsToFrontmatter(frontmatter map[string]any, importsResult *parser
// Merge imported tools using the workflow compiler's merge logic
mergedTools, err := compiler.MergeTools(existingTools, importsResult.MergedTools)
if err != nil {
errMsg := fmt.Sprintf("failed to merge imported tools: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return nil, fmt.Errorf("failed to merge imported tools: %w", err)
}

Expand Down Expand Up @@ -138,11 +142,15 @@ func InspectWorkflowMCP(workflowFile string, serverFilter string, toolFilter str
// Parse the workflow file for MCP configurations
content, err := os.ReadFile(workflowPath)
if err != nil {
errMsg := fmt.Sprintf("failed to read workflow file: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("failed to read workflow file: %w", err)
}

parsedData, err := parser.ExtractFrontmatterFromContent(string(content))
if err != nil {
errMsg := fmt.Sprintf("failed to parse workflow file: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("failed to parse workflow file: %w", err)
}

Expand All @@ -161,12 +169,16 @@ func InspectWorkflowMCP(workflowFile string, serverFilter string, toolFilter str
markdownDir := filepath.Dir(workflowPath)
importsResult, err := parser.ProcessImportsFromFrontmatterWithManifest(parsedData.Frontmatter, markdownDir, nil)
if err != nil {
errMsg := fmt.Sprintf("failed to process imports from frontmatter: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("failed to process imports from frontmatter: %w", err)
}

// Apply imported MCP servers to frontmatter
frontmatterWithImports, err := applyImportsToFrontmatter(parsedData.Frontmatter, importsResult)
if err != nil {
errMsg := fmt.Sprintf("failed to apply imports: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("failed to apply imports: %w", err)
}

Expand All @@ -178,6 +190,8 @@ func InspectWorkflowMCP(workflowFile string, serverFilter string, toolFilter str
fmt.Fprintln(os.Stderr, console.FormatWarningMessage(fmt.Sprintf("MCP configuration validation failed: %v", err)))
fmt.Fprintln(os.Stderr, console.FormatInfoMessage("Continuing with MCP inspection (validation errors may affect results)"))
} else {
errMsg := fmt.Sprintf("MCP configuration validation failed: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("MCP configuration validation failed: %w", err)
}
} else if verbose {
Expand All @@ -189,6 +203,8 @@ func InspectWorkflowMCP(workflowFile string, serverFilter string, toolFilter str
// Extract MCP configurations from frontmatter with imports applied
mcpConfigs, err := parser.ExtractMCPConfigurations(frontmatterWithImports, serverFilter)
if err != nil {
errMsg := fmt.Sprintf("failed to extract MCP configurations: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("failed to extract MCP configurations: %w", err)
}

Expand Down Expand Up @@ -283,6 +299,8 @@ func listWorkflowsWithMCP(workflowsDir string, verbose bool) error {
results, err := ScanWorkflowsForMCP(workflowsDir, "", verbose)
if err != nil {
if os.IsNotExist(err) {
errMsg := "no .github/workflows directory found"
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("no .github/workflows directory found")
}
return err
Expand Down Expand Up @@ -318,6 +336,8 @@ func writeSafeInputsFiles(dir string, safeInputsConfig *workflow.SafeInputsConfi
// Create logs directory
logsDir := filepath.Join(dir, "logs")
if err := os.MkdirAll(logsDir, 0755); err != nil {
errMsg := fmt.Sprintf("failed to create logs directory: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("failed to create logs directory: %w", err)
}

Expand All @@ -340,6 +360,8 @@ func writeSafeInputsFiles(dir string, safeInputsConfig *workflow.SafeInputsConfi
for _, jsFile := range jsFiles {
filePath := filepath.Join(dir, jsFile.name)
if err := os.WriteFile(filePath, []byte(jsFile.content), 0644); err != nil {
errMsg := fmt.Sprintf("failed to write %s: %v", jsFile.name, err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("failed to write %s: %w", jsFile.name, err)
}
if verbose {
Expand All @@ -351,6 +373,8 @@ func writeSafeInputsFiles(dir string, safeInputsConfig *workflow.SafeInputsConfi
toolsJSON := workflow.GenerateSafeInputsToolsConfigForInspector(safeInputsConfig)
toolsPath := filepath.Join(dir, "tools.json")
if err := os.WriteFile(toolsPath, []byte(toolsJSON), 0644); err != nil {
errMsg := fmt.Sprintf("failed to write tools.json: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("failed to write tools.json: %w", err)
}
if verbose {
Expand All @@ -361,6 +385,8 @@ func writeSafeInputsFiles(dir string, safeInputsConfig *workflow.SafeInputsConfi
mcpServerScript := workflow.GenerateSafeInputsMCPServerScriptForInspector(safeInputsConfig)
mcpServerPath := filepath.Join(dir, "mcp-server.cjs")
if err := os.WriteFile(mcpServerPath, []byte(mcpServerScript), 0755); err != nil {
errMsg := fmt.Sprintf("failed to write mcp-server.cjs: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("failed to write mcp-server.cjs: %w", err)
}
if verbose {
Expand Down Expand Up @@ -391,6 +417,8 @@ func writeSafeInputsFiles(dir string, safeInputsConfig *workflow.SafeInputsConfi
mode = 0755
}
if err := os.WriteFile(toolPath, []byte(content), mode); err != nil {
errMsg := fmt.Sprintf("failed to write tool %s: %v", toolName, err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("failed to write tool %s: %w", toolName, err)
}
if verbose {
Expand Down Expand Up @@ -421,6 +449,8 @@ func startSafeInputsHTTPServer(dir string, port int, verbose bool) (*exec.Cmd, e
}

if err := cmd.Start(); err != nil {
errMsg := fmt.Sprintf("failed to start server: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return nil, fmt.Errorf("failed to start server: %w", err)
}

Expand Down Expand Up @@ -481,6 +511,8 @@ func startSafeInputsServer(safeInputsConfig *workflow.SafeInputsConfig, verbose

// Check if node is available
if _, err := exec.LookPath("node"); err != nil {
errMsg := "node not found. Please install Node.js to run the safe-inputs MCP server"
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return nil, nil, "", fmt.Errorf("node not found. Please install Node.js to run the safe-inputs MCP server: %w", err)
}

Expand All @@ -491,6 +523,8 @@ func startSafeInputsServer(safeInputsConfig *workflow.SafeInputsConfig, verbose
// Create temporary directory for safe-inputs files
tmpDir, err := os.MkdirTemp("", "gh-aw-safe-inputs-*")
if err != nil {
errMsg := fmt.Sprintf("failed to create temporary directory: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return nil, nil, "", fmt.Errorf("failed to create temporary directory: %w", err)
}

Expand All @@ -506,6 +540,8 @@ func startSafeInputsServer(safeInputsConfig *workflow.SafeInputsConfig, verbose
if err := os.RemoveAll(tmpDir); err != nil && verbose {
mcpInspectLog.Printf("Warning: failed to clean up temporary directory %s: %v", tmpDir, err)
}
errMsg := fmt.Sprintf("failed to write safe-inputs files: %v", err)
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return nil, nil, "", fmt.Errorf("failed to write safe-inputs files: %w", err)
}

Expand All @@ -515,6 +551,8 @@ func startSafeInputsServer(safeInputsConfig *workflow.SafeInputsConfig, verbose
if err := os.RemoveAll(tmpDir); err != nil && verbose {
mcpInspectLog.Printf("Warning: failed to clean up temporary directory %s: %v", tmpDir, err)
}
errMsg := "failed to find an available port for the HTTP server"
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return nil, nil, "", fmt.Errorf("failed to find an available port for the HTTP server")
}

Expand Down
6 changes: 6 additions & 0 deletions pkg/cli/mcp_validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,15 +188,21 @@ func validateMCPServerConfiguration(cmdPath string) error {
// Check for common error cases
if ctx.Err() == context.DeadlineExceeded {
mcpValidationLog.Print("Status command timed out")
errMsg := "status command timed out - this may indicate a configuration issue"
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("status command timed out - this may indicate a configuration issue")
}

mcpValidationLog.Printf("Status command failed: %v", err)

// If the command failed, provide helpful error message
if cmdPath != "" {
errMsg := fmt.Sprintf("failed to run status command with custom command '%s': %v\nOutput: %s\n\nPlease ensure:\n - The command path is correct and executable\n - You are in a git repository with .github/workflows directory", cmdPath, err, string(output))
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("failed to run status command with custom command '%s': %w\nOutput: %s\n\nPlease ensure:\n - The command path is correct and executable\n - You are in a git repository with .github/workflows directory", cmdPath, err, string(output))
}
errMsg := fmt.Sprintf("failed to run status command: %v\nOutput: %s\n\nPlease ensure:\n - gh CLI is installed and in PATH\n - gh aw extension is installed (run: gh extension install githubnext/gh-aw)\n - You are in a git repository with .github/workflows directory", err, string(output))
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(errMsg))
return fmt.Errorf("failed to run status command: %w\nOutput: %s\n\nPlease ensure:\n - gh CLI is installed and in PATH\n - gh aw extension is installed (run: gh extension install githubnext/gh-aw)\n - You are in a git repository with .github/workflows directory", err, string(output))
}

Expand Down
Loading