UAT: agents info JSON output uses config_path key instead of spec-required config #4105

Open
opened 2026-04-06 10:21:18 +00:00 by hurui200320 · 1 comment
Member

Metadata

  • Branch: fix/agents-info-json-config-key
  • Commit Message: fix(cli): rename config_path to config in agents info JSON output
  • Milestone: None (backlog)
  • Parent Epic: TBD - requires manual linking

Description

Background

The agents info --format json command (invoked as agents --format json info) produces
JSON output where the config file path is reported under the key config_path. However,
docs/specification.md (line ~785) defines the key as config. This mismatch breaks
spec compliance for any programmatic consumer that parses the JSON output.

The defect is localised to src/cleveragents/cli/commands/system.py in the
build_info_data() function, which constructs the output dictionary using config_path
instead of config.

Current Behavior

Running:

agents --format json info

produces:

{ "config_path": "/app/data/config.toml" }

Expected Behavior

Per docs/specification.md (line ~785), the output should use the key config:

{ "config": "/home/alex/.cleveragents/config.toml" }

Acceptance Criteria

  • agents --format json info outputs "config" as the key for the config file path
  • The key config_path no longer appears in the JSON output of agents info
  • All existing tests for agents info pass with the renamed key
  • No other output formats (plain, table) are inadvertently affected

Subtasks

  • In src/cleveragents/cli/commands/system.py, rename the config_path key to
    config in the dictionary returned by build_info_data()
  • Search for any other references to config_path in the agents info output path
    and rename them consistently
  • Update or add tests that assert the JSON output key is config
  • Run nox (all default sessions), fix any errors
  • Verify coverage >= 97% via nox -s coverage_report

Definition of Done

  • All subtasks above are completed and checked off
  • A Git commit is created where the first line of the commit message
    matches the Commit Message in Metadata exactly
  • The commit is pushed to the branch from Metadata
  • PR submitted to master, reviewed, and merged
  • All nox stages pass
  • Coverage >= 97%
## Metadata - **Branch**: `fix/agents-info-json-config-key` - **Commit Message**: `fix(cli): rename config_path to config in agents info JSON output` - **Milestone**: None (backlog) - **Parent Epic**: TBD - requires manual linking ## Description ### Background The `agents info --format json` command (invoked as `agents --format json info`) produces JSON output where the config file path is reported under the key `config_path`. However, `docs/specification.md` (line ~785) defines the key as `config`. This mismatch breaks spec compliance for any programmatic consumer that parses the JSON output. The defect is localised to `src/cleveragents/cli/commands/system.py` in the `build_info_data()` function, which constructs the output dictionary using `config_path` instead of `config`. ### Current Behavior Running: ``` agents --format json info ``` produces: ```json { "config_path": "/app/data/config.toml" } ``` ### Expected Behavior Per `docs/specification.md` (line ~785), the output should use the key `config`: ```json { "config": "/home/alex/.cleveragents/config.toml" } ``` ### Acceptance Criteria - [ ] `agents --format json info` outputs `"config"` as the key for the config file path - [ ] The key `config_path` no longer appears in the JSON output of `agents info` - [ ] All existing tests for `agents info` pass with the renamed key - [ ] No other output formats (plain, table) are inadvertently affected ## Subtasks - [ ] In `src/cleveragents/cli/commands/system.py`, rename the `config_path` key to `config` in the dictionary returned by `build_info_data()` - [ ] Search for any other references to `config_path` in the `agents info` output path and rename them consistently - [ ] Update or add tests that assert the JSON output key is `config` - [ ] Run `nox` (all default sessions), fix any errors - [ ] Verify coverage >= 97% via `nox -s coverage_report` ## Definition of Done - [ ] All subtasks above are completed and checked off - [ ] A Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly - [ ] The commit is pushed to the branch from Metadata - [ ] PR submitted to `master`, reviewed, and merged - [ ] All nox stages pass - [ ] Coverage >= 97%
Owner

Thank you for filing this issue, @hurui200320. This is a clear and well-documented spec compliance bug — the key name mismatch between config_path and config is straightforward to fix.

Triage assessment:

  • Clear title and description
  • Spec reference (line ~785)
  • Current vs expected behavior
  • Metadata (commit message, branch)
  • Subtasks and Definition of Done
  • Priority: Priority/Backlog is appropriate — this is a cosmetic/compliance fix
  • Story Points: XS (1 point) — single key rename in one function
  • Parent Epic: Should be linked to a CLI output compliance epic

This issue is ready for verification and implementation.


Automated by CleverAgents Bot
Supervisor: Human Liaison | Agent: ca-human-liaison

Thank you for filing this issue, @hurui200320. This is a clear and well-documented spec compliance bug — the key name mismatch between `config_path` and `config` is straightforward to fix. **Triage assessment:** - ✅ Clear title and description - ✅ Spec reference (line ~785) - ✅ Current vs expected behavior - ✅ Metadata (commit message, branch) - ✅ Subtasks and Definition of Done - **Priority**: `Priority/Backlog` is appropriate — this is a cosmetic/compliance fix - **Story Points**: XS (1 point) — single key rename in one function - **Parent Epic**: Should be linked to a CLI output compliance epic This issue is ready for verification and implementation. --- **Automated by CleverAgents Bot** Supervisor: Human Liaison | Agent: ca-human-liaison
HAL9000 added this to the v3.5.0 milestone 2026-04-09 03:11:01 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
cleveragents/cleveragents-core#4105
No description provided.