cleveragents/cleveragents-core

Fork 3

UAT: `ProviderInfo.api_key_env_var` for Azure is `"AZURE_API_KEY"` but primary env var is `AZURE_OPENAI_API_KEY` — misleading user guidance #4758

New issue

Open

opened 2026-04-08 18:54:04 +00:00 by HAL9000 · 1 comment

HAL9000 commented

2026-04-08 18:54:04 +00:00

Owner

Summary

ProviderRegistry._discover_providers() sets api_key_env_var by uppercasing the Settings attribute name (key_attr.upper()). For the Azure provider, key_attr = "azure_api_key", so api_key_env_var becomes "AZURE_API_KEY". However, the primary environment variable documented and expected by the system is AZURE_OPENAI_API_KEY (with AZURE_API_KEY as a secondary alias). This means ProviderInfo.api_key_env_var gives incorrect guidance to users and any code that reads this field to display configuration help.

Expected Behavior

ProviderInfo.api_key_env_var for the Azure provider should be "AZURE_OPENAI_API_KEY" — the canonical, primary environment variable name documented in the spec and used in Settings._PROVIDER_ENV_MAP.

Actual Behavior

# src/cleveragents/providers/registry.py — _discover_providers()

PROVIDER_KEY_ATTRS: ClassVar[dict[ProviderType, str]] = {
    ...
    ProviderType.AZURE: "azure_api_key",  # Settings attribute name
    ...
}

def _discover_providers(self) -> None:
    for provider_type, key_attr in self.PROVIDER_KEY_ATTRS.items():
        ...
        provider_info = ProviderInfo(
            ...
            api_key_env_var=key_attr.upper(),  # "AZURE_API_KEY" ← wrong
            ...
        )

The actual env var mapping from Settings._PROVIDER_ENV_MAP:

"azure_api_key": ("AZURE_OPENAI_API_KEY", "AZURE_API_KEY"),
#                  ^^^^^^^^^^^^^^^^^^^^ primary  ^^^^^^^^^^^ alias

So ProviderInfo.api_key_env_var = "AZURE_API_KEY" but the primary env var is "AZURE_OPENAI_API_KEY".

The same issue affects other providers where the Settings attribute name differs from the primary env var:

hf_token → "HF_TOKEN" (correct, matches primary)
google_api_key → "GOOGLE_API_KEY" (correct, matches primary)
azure_api_key → "AZURE_API_KEY" (wrong, primary is AZURE_OPENAI_API_KEY)

Impact

CLI output and error messages that reference provider_info.api_key_env_var for Azure will tell users to set AZURE_API_KEY instead of AZURE_OPENAI_API_KEY
Users following the guidance will set the wrong variable and be confused when it doesn't work
The docs/api/providers.md environment variable table lists AZURE_OPENAI_API_KEY as the correct variable, creating a documentation/runtime inconsistency

Code Location

src/cleveragents/providers/registry.py — _discover_providers() method, api_key_env_var=key_attr.upper() line

Fix Direction

Use the first entry from Settings._PROVIDER_ENV_MAP as the canonical env var name, rather than uppercasing the attribute name:

def _discover_providers(self) -> None:
    for provider_type, key_attr in self.PROVIDER_KEY_ATTRS.items():
        # Use the primary env var name from Settings._PROVIDER_ENV_MAP
        env_var_names = Settings._PROVIDER_ENV_MAP.get(key_attr, ())
        api_key_env_var = env_var_names[0] if env_var_names else key_attr.upper()
        
        provider_info = ProviderInfo(
            ...
            api_key_env_var=api_key_env_var,  # "AZURE_OPENAI_API_KEY" ✓
            ...
        )

This ensures the displayed env var name matches the primary variable documented in the spec.

Automated by CleverAgents Bot
Supervisor: UAT Testing | Agent: uat-tester

## Summary `ProviderRegistry._discover_providers()` sets `api_key_env_var` by uppercasing the Settings attribute name (`key_attr.upper()`). For the Azure provider, `key_attr = "azure_api_key"`, so `api_key_env_var` becomes `"AZURE_API_KEY"`. However, the primary environment variable documented and expected by the system is `AZURE_OPENAI_API_KEY` (with `AZURE_API_KEY` as a secondary alias). This means `ProviderInfo.api_key_env_var` gives incorrect guidance to users and any code that reads this field to display configuration help. ## Expected Behavior `ProviderInfo.api_key_env_var` for the Azure provider should be `"AZURE_OPENAI_API_KEY"` — the canonical, primary environment variable name documented in the spec and used in `Settings._PROVIDER_ENV_MAP`. ## Actual Behavior ```python # src/cleveragents/providers/registry.py — _discover_providers() PROVIDER_KEY_ATTRS: ClassVar[dict[ProviderType, str]] = { ... ProviderType.AZURE: "azure_api_key", # Settings attribute name ... } def _discover_providers(self) -> None: for provider_type, key_attr in self.PROVIDER_KEY_ATTRS.items(): ... provider_info = ProviderInfo( ... api_key_env_var=key_attr.upper(), # "AZURE_API_KEY" ← wrong ... ) ``` The actual env var mapping from `Settings._PROVIDER_ENV_MAP`: ```python "azure_api_key": ("AZURE_OPENAI_API_KEY", "AZURE_API_KEY"), # ^^^^^^^^^^^^^^^^^^^^ primary ^^^^^^^^^^^ alias ``` So `ProviderInfo.api_key_env_var = "AZURE_API_KEY"` but the primary env var is `"AZURE_OPENAI_API_KEY"`. The same issue affects other providers where the Settings attribute name differs from the primary env var: - `hf_token` → `"HF_TOKEN"` (correct, matches primary) - `google_api_key` → `"GOOGLE_API_KEY"` (correct, matches primary) - `azure_api_key` → `"AZURE_API_KEY"` (wrong, primary is `AZURE_OPENAI_API_KEY`) ## Impact - CLI output and error messages that reference `provider_info.api_key_env_var` for Azure will tell users to set `AZURE_API_KEY` instead of `AZURE_OPENAI_API_KEY` - Users following the guidance will set the wrong variable and be confused when it doesn't work - The `docs/api/providers.md` environment variable table lists `AZURE_OPENAI_API_KEY` as the correct variable, creating a documentation/runtime inconsistency ## Code Location - `src/cleveragents/providers/registry.py` — `_discover_providers()` method, `api_key_env_var=key_attr.upper()` line ## Fix Direction Use the first entry from `Settings._PROVIDER_ENV_MAP` as the canonical env var name, rather than uppercasing the attribute name: ```python def _discover_providers(self) -> None: for provider_type, key_attr in self.PROVIDER_KEY_ATTRS.items(): # Use the primary env var name from Settings._PROVIDER_ENV_MAP env_var_names = Settings._PROVIDER_ENV_MAP.get(key_attr, ()) api_key_env_var = env_var_names[0] if env_var_names else key_attr.upper() provider_info = ProviderInfo( ... api_key_env_var=api_key_env_var, # "AZURE_OPENAI_API_KEY" ✓ ... ) ``` This ensures the displayed env var name matches the primary variable documented in the spec. --- **Automated by CleverAgents Bot** Supervisor: UAT Testing | Agent: uat-tester

HAL9000 referenced this issue

2026-04-08 18:55:48 +00:00

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

HAL9000 added the

labels

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

HAL9000 commented

2026-04-09 03:04:36 +00:00

Author

Owner

Issue triaged by project owner:

State: Verified
Priority: Medium — spec compliance bug identified by UAT testing
Story Points: 3 (M) — targeted fix to align implementation with spec
MoSCoW: Must Have — spec compliance is required for correct system behavior

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

Issue triaged by project owner: - **State**: Verified - **Priority**: Medium — spec compliance bug identified by UAT testing - **Story Points**: 3 (M) — targeted fix to align implementation with spec - **MoSCoW**: Must Have — spec compliance is required for correct system behavior --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner

HAL9000 added

and removed

labels

2026-04-09 03:04:48 +00:00

HAL9000 added this to the v3.5.0 milestone