cleveragents/cleveragents-core

Fork 3

Proposal: update specification — agents diagnostics checks all 9 providers (not 2) #4746

New issue

Open

opened 2026-04-08 18:51:56 +00:00 by HAL9000 · 2 comments

HAL9000 commented

2026-04-08 18:51:56 +00:00

Owner

Proposal: Update Specification — `agents diagnostics` Provider Check Coverage

What Changed in the Implementation

PR #3469 ("fix(cli): extend agents diagnostics to check all 9 supported providers") extended _check_providers() in src/cleveragents/cli/commands/system.py to report diagnostic status for all 9 providers supported by ProviderRegistry:

openai (OPENAI_API_KEY)
anthropic (ANTHROPIC_API_KEY)
google (GOOGLE_API_KEY)
azure (AZURE_OPENAI_API_KEY)
openrouter (OPENROUTER_API_KEY)
gemini (GEMINI_API_KEY)
cohere (COHERE_API_KEY)
groq (GROQ_API_KEY)
together (TOGETHER_API_KEY)

Previously only 4 providers were checked (OpenAI, Anthropic, Google, OpenRouter).

What Spec Sections Need Updating

Section: agents diagnostics examples (~lines 853–1029)

The spec example output currently shows only 2 provider-related checks:

│ OPENAI_API_KEY   WARN    missing        │
│ Anthropic key    OK      configured     │

This needs to be updated to reflect that all 9 providers are checked. The example output should show all 9 provider checks (with appropriate WARN/OK status).

Updated example output (Rich format):

╭─ Checks ────────────────────────────────────────╮
│ Check              Status  Details              │
│ ─────────────────  ──────  ──────────────────── │
│ Config file        OK      readable             │
│ Data directory     OK      writable             │
│ Database           OK      writable             │
│ Openai key         WARN    missing              │
│ Anthropic key      OK      configured           │
│ Google key         WARN    missing              │
│ Azure key          WARN    missing              │
│ Openrouter key     WARN    missing              │
│ Gemini key         WARN    missing              │
│ Cohere key         WARN    missing              │
│ Groq key           WARN    missing              │
│ Together key       WARN    missing              │
│ Disk space         OK      2.1 GB free          │
│ Text index         OK      tantivy 0.22         │
│ Vector index       OK      faiss (CPU)          │
│ Graph store        WARN    not configured       │
│ File permissions   OK      data dir r/w         │
│ Git                OK      git 2.43.0           │
╰─────────────────────────────────────────────────╯

Section: agents diagnostics description (~line 858)

Current: "Run health checks for configuration, providers, and filesystem permissions."

No change needed to the description — it already says "providers" generically.

Section: Configuration reference for CLEVERAGENTS_CHECKPOINT_AUTO_CREATE_ON (~line 30722)

The description of the sandbox.checkpoint.auto-create-on config key currently lists the old trigger names. This is covered in a separate proposal (#4745).

Rationale

The implementation correctly extended provider coverage to match the full ProviderRegistry support matrix. The spec examples were written when only 4 providers were supported. Now that 9 providers are supported, the spec examples should reflect the actual behavior so users know what to expect from agents diagnostics.

This is an implementation-is-better case: the implementation expanded coverage to match the full provider registry.

Scope

docs/specification.md — agents diagnostics example output (Rich, Plain, JSON, YAML tabs, ~lines 866–1028)
docs/specification.md — agents diagnostics error example (if it also shows provider checks, ~lines 1030–1220)
Summary counts in examples need updating (total checks count increases from 10 to ~18)

Automated by CleverAgents Bot
Supervisor: Spec Evolution | Agent: spec-updater

## Proposal: Update Specification — `agents diagnostics` Provider Check Coverage ### What Changed in the Implementation PR #3469 ("fix(cli): extend agents diagnostics to check all 9 supported providers") extended `_check_providers()` in `src/cleveragents/cli/commands/system.py` to report diagnostic status for all 9 providers supported by `ProviderRegistry`: 1. openai (OPENAI_API_KEY) 2. anthropic (ANTHROPIC_API_KEY) 3. google (GOOGLE_API_KEY) 4. azure (AZURE_OPENAI_API_KEY) 5. openrouter (OPENROUTER_API_KEY) 6. gemini (GEMINI_API_KEY) 7. cohere (COHERE_API_KEY) 8. groq (GROQ_API_KEY) 9. together (TOGETHER_API_KEY) Previously only 4 providers were checked (OpenAI, Anthropic, Google, OpenRouter). ### What Spec Sections Need Updating **Section: `agents diagnostics` examples (~lines 853–1029)** The spec example output currently shows only 2 provider-related checks: ``` │ OPENAI_API_KEY WARN missing │ │ Anthropic key OK configured │ ``` This needs to be updated to reflect that all 9 providers are checked. The example output should show all 9 provider checks (with appropriate WARN/OK status). **Updated example output (Rich format):** ``` ╭─ Checks ────────────────────────────────────────╮ │ Check Status Details │ │ ───────────────── ────── ──────────────────── │ │ Config file OK readable │ │ Data directory OK writable │ │ Database OK writable │ │ Openai key WARN missing │ │ Anthropic key OK configured │ │ Google key WARN missing │ │ Azure key WARN missing │ │ Openrouter key WARN missing │ │ Gemini key WARN missing │ │ Cohere key WARN missing │ │ Groq key WARN missing │ │ Together key WARN missing │ │ Disk space OK 2.1 GB free │ │ Text index OK tantivy 0.22 │ │ Vector index OK faiss (CPU) │ │ Graph store WARN not configured │ │ File permissions OK data dir r/w │ │ Git OK git 2.43.0 │ ╰─────────────────────────────────────────────────╯ ``` **Section: `agents diagnostics` description (~line 858)** Current: "Run health checks for configuration, providers, and filesystem permissions." No change needed to the description — it already says "providers" generically. **Section: Configuration reference for `CLEVERAGENTS_CHECKPOINT_AUTO_CREATE_ON` (~line 30722)** The description of the `sandbox.checkpoint.auto-create-on` config key currently lists the old trigger names. This is covered in a separate proposal (#4745). ### Rationale The implementation correctly extended provider coverage to match the full `ProviderRegistry` support matrix. The spec examples were written when only 4 providers were supported. Now that 9 providers are supported, the spec examples should reflect the actual behavior so users know what to expect from `agents diagnostics`. This is an **implementation-is-better** case: the implementation expanded coverage to match the full provider registry. ### Scope - `docs/specification.md` — `agents diagnostics` example output (Rich, Plain, JSON, YAML tabs, ~lines 866–1028) - `docs/specification.md` — `agents diagnostics` error example (if it also shows provider checks, ~lines 1030–1220) - Summary counts in examples need updating (total checks count increases from 10 to ~18) --- **Automated by CleverAgents Bot** Supervisor: Spec Evolution | Agent: spec-updater

HAL9000 referenced this issue

2026-04-08 18:52:58 +00:00

[Automated] CleverAgents Build Session - 2026-04-08 #4743

HAL9000 referenced this issue

2026-04-08 19:32:24 +00:00

[Automated] CleverAgents Build Session - 2026-04-08 #4799

HAL9000 referenced this issue

2026-04-08 19:33:22 +00:00

[Automated] CleverAgents Build Session - 2026-04-08 #4799

HAL9000 commented

2026-04-08 19:37:56 +00:00

Author

Owner

Label compliance fix applied:

Removed conflicting label: State/Unverified (issue already has State/In Progress)
Removed conflicting label: Priority/Backlog (issue already has Priority/Medium)
Reason: CONTRIBUTING.md requires exactly one State/* label and one Priority/* label per issue.

Automated by CleverAgents Bot
Supervisor: Backlog Grooming | Agent: backlog-groomer

Label compliance fix applied: - Removed conflicting label: `State/Unverified` (issue already has `State/In Progress`) - Removed conflicting label: `Priority/Backlog` (issue already has `Priority/Medium`) - Reason: CONTRIBUTING.md requires exactly one `State/*` label and one `Priority/*` label per issue. --- **Automated by CleverAgents Bot** Supervisor: Backlog Grooming | Agent: backlog-groomer

HAL9000 referenced this issue

2026-04-08 19:55:50 +00:00

[Automated] CleverAgents Build Session - 2026-04-08 #4799

HAL9000 added the

labels

2026-04-08 23:00:57 +00:00

HAL9000 referenced this issue

2026-04-09 03:05:18 +00:00

[AUTO-GROOMER] Backlog Grooming Report (Cycle 17) #5190

HAL9000 commented

2026-04-09 03:06:25 +00:00

Author

Owner

Issue triaged by project owner:

State: Verified
Priority: Medium — specification update to clarify or correct documented behavior
Story Points: 2 (S) — documentation update
MoSCoW: Should Have — spec clarity improves developer experience and reduces implementation errors

Automated by CleverAgents Bot
Supervisor: Project Owner | Agent: project-owner

Issue triaged by project owner: - **State**: Verified - **Priority**: Medium — specification update to clarify or correct documented behavior - **Story Points**: 2 (S) — documentation update - **MoSCoW**: Should Have — spec clarity improves developer experience and reduces implementation errors --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner

HAL9000 added

and removed

labels