Skip to content

[cli-tools-test] UX: Parameter naming inconsistency between logs (--workflow_name) and compile (--workflows) #35655

@github-actions

Description

@github-actions

Problem Description

The logs and compile MCP tools use different parameter names and types for specifying workflows, which causes confusion and errors.

Commands/Tools

  • Tool: logs and compile
  • Parameter in logs: --workflow_name (string, single workflow)
  • Parameter in compile: --workflows (array, one or more workflows)

Steps to Reproduce

  1. Note that logs uses --workflow_name "ci-doctor" to filter by workflow
  2. Try to compile a specific workflow using the same pattern: --workflow_name "ci-doctor"
  3. Receive error: Unknown parameter 'workflow_name'. Did you mean 'workflows'?

Expected Behavior

Consistent parameter naming across tools. Users who learn to use --workflow_name in logs naturally try the same parameter in compile.

Actual Behavior

compile returns an error suggesting --workflows (array) instead of --workflow_name (string).

The error message is helpful (Did you mean 'workflows'?) but the inconsistency still creates friction.

Current Parameter Reference

Tool Parameter Type Description
logs --workflow_name string Single workflow filter
compile --workflows array One or more workflows to compile

Suggested Fix

Options (in order of preference):

  1. Add --workflow_name as an alias in compile that accepts a single string and wraps it in an array
  2. Rename logs parameter to --workflow (singular, consistent with compile)
  3. Document the difference clearly in both tool help texts

Environment

  • Repository: github/gh-aw
  • Run ID: 26622137229
  • Date: 2026-05-29
  • Discovered via: Daily CLI Tools Exploratory Tester

Impact

  • Severity: Low
  • Frequency: Always (structural inconsistency)
  • Workaround: Use --workflows '["workflow-name"]' or printf '{"workflows":["name"]}' | agenticworkflows compile .

Additional Context

Discovered during systematic exploratory testing of the audit, logs, and compile MCP tools. All three tools are otherwise functioning correctly:

  • logs: ✅ Filtering by date, engine, workflow name works correctly; edge cases handled gracefully
  • audit: ✅ Correctly reports run metadata, job timeline, tool usage, firewall analysis
  • compile: ✅ 236/236 workflows compile successfully; invalid workflow names return helpful errors

References: §26622137229

Generated by 🧪 Daily CLI Tools Exploratory Tester · sonnet46 2.6M ·

  • expires on Jun 5, 2026, 6:43 AM UTC

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions