Skip to content

Agent Zero AI framework

Remove local provider dummy keys that override saved credentials

Alessandroa62aad4aceb3
diff --git a/conf/AGENTS.md b/conf/AGENTS.md
index f81c872bf..e658a9876 100644
--- a/conf/AGENTS.md
+++ b/conf/AGENTS.md
@@ -17,6 +17,7 @@
- Keep provider IDs and settings keys stable unless all loaders, UI references, migrations, and tests are updated.
- Defaults must work in a clean checkout and in Docker.
- Chat Completions is the transport default; providers intentionally using Responses must set `a0_api_mode: responses` explicitly.
+- Local provider defaults omit `api_key`: LiteLLM handles unauthenticated endpoints, while saved or explicit keys remain available for authenticated servers. Static dummy keys would override saved keys. OAuth compatibility keys belong to the OAuth plugin's connected-account hook.
- Templates must avoid accidentally unignoring private runtime content.
## Work Guidance
diff --git a/conf/model_providers.yaml b/conf/model_providers.yaml
index c7676f0db..d3c6d5d64 100644
--- a/conf/model_providers.yaml
+++ b/conf/model_providers.yaml
@@ -108,7 +108,6 @@ chat:
kwargs:
a0_api_mode: chat
api_base: "http://host.docker.internal:1234/v1"
- api_key: "lm-studio"
llama_cpp:
name: llama.cpp
litellm_provider: hosted_vllm
@@ -118,7 +117,6 @@ chat:
kwargs:
a0_api_mode: chat
api_base: "http://host.docker.internal:8080/v1"
- api_key: "llama-cpp"
mistral:
name: Mistral AI
litellm_provider: mistral
@@ -167,7 +165,6 @@ chat:
kwargs:
a0_api_mode: chat
api_base: "http://host.docker.internal:8000/v1"
- api_key: "omlx"
ollama_cloud:
name: Ollama Cloud
litellm_provider: openai
@@ -234,7 +231,6 @@ chat:
kwargs:
a0_api_mode: chat
api_base: "http://host.docker.internal:8000/v1"
- api_key: "vllm"
xai:
name: xAI
litellm_provider: xai
@@ -276,13 +272,11 @@ embedding:
litellm_provider: lm_studio
kwargs:
api_base: "http://host.docker.internal:1234/v1"
- api_key: "lm-studio"
llama_cpp:
name: llama.cpp
litellm_provider: hosted_vllm
kwargs:
api_base: "http://host.docker.internal:8080/v1"
- api_key: "llama-cpp"
mistral:
name: Mistral AI
litellm_provider: mistral
@@ -301,7 +295,6 @@ embedding:
litellm_provider: hosted_vllm
kwargs:
api_base: "http://host.docker.internal:8000/v1"
- api_key: "omlx"
openai:
name: OpenAI
litellm_provider: openai
@@ -340,7 +333,6 @@ embedding:
litellm_provider: hosted_vllm
kwargs:
api_base: "http://host.docker.internal:8000/v1"
- api_key: "vllm"
other:
name: Other OpenAI compatible
litellm_provider: openai
diff --git a/tests/test_model_config_api_keys.py b/tests/test_model_config_api_keys.py
index 6b64aa662..942702d21 100644
--- a/tests/test_model_config_api_keys.py
+++ b/tests/test_model_config_api_keys.py
@@ -606,7 +606,7 @@ def test_local_provider_defaults_are_docker_friendly():
assert provider_config["chat"]["lm_studio"]["kwargs"]["api_base"] == (
"http://host.docker.internal:1234/v1"
)
- assert provider_config["chat"]["lm_studio"]["kwargs"]["api_key"] == "lm-studio"
+ assert "api_key" not in provider_config["chat"]["lm_studio"]["kwargs"]
assert provider_config["chat"]["lm_studio"]["models_list"]["default_base"] == (
"http://host.docker.internal:1234"
)
@@ -614,7 +614,7 @@ def test_local_provider_defaults_are_docker_friendly():
assert provider_config["chat"]["llama_cpp"]["kwargs"]["api_base"] == (
"http://host.docker.internal:8080/v1"
)
- assert provider_config["chat"]["llama_cpp"]["kwargs"]["api_key"] == "llama-cpp"
+ assert "api_key" not in provider_config["chat"]["llama_cpp"]["kwargs"]
assert provider_config["chat"]["llama_cpp"]["models_list"]["default_base"] == (
"http://host.docker.internal:8080"
)
@@ -629,7 +629,7 @@ def test_local_provider_defaults_are_docker_friendly():
assert provider_config["chat"]["omlx"]["kwargs"]["api_base"] == (
"http://host.docker.internal:8000/v1"
)
- assert provider_config["chat"]["omlx"]["kwargs"]["api_key"] == "omlx"
+ assert "api_key" not in provider_config["chat"]["omlx"]["kwargs"]
assert provider_config["chat"]["omlx"]["models_list"]["default_base"] == (
"http://host.docker.internal:8000"
)
@@ -638,7 +638,7 @@ def test_local_provider_defaults_are_docker_friendly():
assert provider_config["chat"]["vllm"]["kwargs"]["api_base"] == (
"http://host.docker.internal:8000/v1"
)
- assert provider_config["chat"]["vllm"]["kwargs"]["api_key"] == "vllm"
+ assert "api_key" not in provider_config["chat"]["vllm"]["kwargs"]
assert provider_config["chat"]["vllm"]["models_list"]["default_base"] == (
"http://host.docker.internal:8000"
)
@@ -646,12 +646,12 @@ def test_local_provider_defaults_are_docker_friendly():
assert provider_config["embedding"]["lm_studio"]["kwargs"]["api_base"] == (
"http://host.docker.internal:1234/v1"
)
- assert provider_config["embedding"]["lm_studio"]["kwargs"]["api_key"] == "lm-studio"
+ assert "api_key" not in provider_config["embedding"]["lm_studio"]["kwargs"]
assert provider_config["embedding"]["llama_cpp"]["litellm_provider"] == "hosted_vllm"
assert provider_config["embedding"]["llama_cpp"]["kwargs"]["api_base"] == (
"http://host.docker.internal:8080/v1"
)
- assert provider_config["embedding"]["llama_cpp"]["kwargs"]["api_key"] == "llama-cpp"
+ assert "api_key" not in provider_config["embedding"]["llama_cpp"]["kwargs"]
assert provider_config["embedding"]["ollama"]["kwargs"]["api_base"] == (
"http://host.docker.internal:11434"
)
@@ -659,12 +659,12 @@ def test_local_provider_defaults_are_docker_friendly():
assert provider_config["embedding"]["omlx"]["kwargs"]["api_base"] == (
"http://host.docker.internal:8000/v1"
)
- assert provider_config["embedding"]["omlx"]["kwargs"]["api_key"] == "omlx"
+ assert "api_key" not in provider_config["embedding"]["omlx"]["kwargs"]
assert provider_config["embedding"]["vllm"]["litellm_provider"] == "hosted_vllm"
assert provider_config["embedding"]["vllm"]["kwargs"]["api_base"] == (
"http://host.docker.internal:8000/v1"
)
- assert provider_config["embedding"]["vllm"]["kwargs"]["api_key"] == "vllm"
+ assert "api_key" not in provider_config["embedding"]["vllm"]["kwargs"]
def test_local_provider_runtime_defaults_and_overrides(monkeypatch):
@@ -673,12 +673,12 @@ def test_local_provider_runtime_defaults_and_overrides(monkeypatch):
lm_chat = models.get_chat_model("lm_studio", "local-chat-model")
assert lm_chat.model_name == "lm_studio/local-chat-model"
assert lm_chat.kwargs["api_base"] == "http://host.docker.internal:1234/v1"
- assert lm_chat.kwargs["api_key"] == "lm-studio"
+ assert "api_key" not in lm_chat.kwargs
lm_embedding = models.get_embedding_model("lm_studio", "nomic-embed-text")
assert lm_embedding.model_name == "lm_studio/nomic-embed-text"
assert lm_embedding.kwargs["api_base"] == "http://host.docker.internal:1234/v1"
- assert lm_embedding.kwargs["api_key"] == "lm-studio"
+ assert "api_key" not in lm_embedding.kwargs
custom_lm_embedding = models.get_embedding_model(
"lm_studio",
@@ -692,12 +692,12 @@ def test_local_provider_runtime_defaults_and_overrides(monkeypatch):
llama_cpp_chat = models.get_chat_model("llama_cpp", "local-chat-model")
assert llama_cpp_chat.model_name == "hosted_vllm/local-chat-model"
assert llama_cpp_chat.kwargs["api_base"] == "http://host.docker.internal:8080/v1"
- assert llama_cpp_chat.kwargs["api_key"] == "llama-cpp"
+ assert "api_key" not in llama_cpp_chat.kwargs
llama_cpp_embedding = models.get_embedding_model("llama_cpp", "local-embedding-model")
assert llama_cpp_embedding.model_name == "hosted_vllm/local-embedding-model"
assert llama_cpp_embedding.kwargs["api_base"] == "http://host.docker.internal:8080/v1"
- assert llama_cpp_embedding.kwargs["api_key"] == "llama-cpp"
+ assert "api_key" not in llama_cpp_embedding.kwargs
ollama_embedding = models.get_embedding_model("ollama", "nomic-embed-text")
assert ollama_embedding.model_name == "ollama/nomic-embed-text"
@@ -707,12 +707,12 @@ def test_local_provider_runtime_defaults_and_overrides(monkeypatch):
omlx_chat = models.get_chat_model("omlx", "local-chat-model")
assert omlx_chat.model_name == "hosted_vllm/local-chat-model"
assert omlx_chat.kwargs["api_base"] == "http://host.docker.internal:8000/v1"
- assert omlx_chat.kwargs["api_key"] == "omlx"
+ assert "api_key" not in omlx_chat.kwargs
omlx_embedding = models.get_embedding_model("omlx", "local-embedding-model")
assert omlx_embedding.model_name == "hosted_vllm/local-embedding-model"
assert omlx_embedding.kwargs["api_base"] == "http://host.docker.internal:8000/v1"
- assert omlx_embedding.kwargs["api_key"] == "omlx"
+ assert "api_key" not in omlx_embedding.kwargs
custom_omlx_chat = models.get_chat_model(
"omlx",
@@ -726,12 +726,12 @@ def test_local_provider_runtime_defaults_and_overrides(monkeypatch):
vllm_chat = models.get_chat_model("vllm", "local-chat-model")
assert vllm_chat.model_name == "hosted_vllm/local-chat-model"
assert vllm_chat.kwargs["api_base"] == "http://host.docker.internal:8000/v1"
- assert vllm_chat.kwargs["api_key"] == "vllm"
+ assert "api_key" not in vllm_chat.kwargs
vllm_embedding = models.get_embedding_model("vllm", "local-embedding-model")
assert vllm_embedding.model_name == "hosted_vllm/local-embedding-model"
assert vllm_embedding.kwargs["api_base"] == "http://host.docker.internal:8000/v1"
- assert vllm_embedding.kwargs["api_key"] == "vllm"
+ assert "api_key" not in vllm_embedding.kwargs
custom_vllm_chat = models.get_chat_model(
"vllm",
@@ -743,6 +743,39 @@ def test_local_provider_runtime_defaults_and_overrides(monkeypatch):
assert custom_vllm_chat.kwargs["api_key"] == "real-local-key"
[email protected]("provider", ["lm_studio", "llama_cpp", "omlx", "vllm"])
+def test_saved_local_api_keys_reach_every_model_slot(monkeypatch, tmp_path, provider):
+ from helpers import dotenv
+ from plugins._model_config.helpers import model_config
+
+ monkeypatch.setattr(dotenv, "get_dotenv_file_path", lambda: str(tmp_path / ".env"))
+ for key in (
+ f"API_KEY_{provider.upper()}", f"{provider.upper()}_API_KEY",
+ f"{provider.upper()}_API_TOKEN", "API_KEY_HOSTED_VLLM",
+ "HOSTED_VLLM_API_KEY", "HOSTED_VLLM_API_TOKEN",
+ ):
+ monkeypatch.setenv(key, "")
+ config = {
+ slot: {"provider": provider, "name": "local-model"}
+ for slot in ("chat_model", "utility_model", "vision_model", "embedding_model")
+ }
+ monkeypatch.setattr(model_config, "get_effective_config", lambda _agent=None: config)
+ handler = ApiKeys(Flask(__name__), threading.Lock())
+
+ for saved_key in ("local-first-key", "local-replacement-key", ""):
+ assert handler._set_keys({"keys": {provider: saved_key}}) == {"ok": True}
+ assert handler._reveal_key({"provider": provider})["value"] == saved_key
+ for build in (
+ model_config.build_chat_model, model_config.build_utility_model,
+ model_config.build_vision_model, model_config.build_embedding_model,
+ ):
+ assert build().kwargs.get("api_key", "") == saved_key
+
+ for build in (models.get_chat_model, models.get_embedding_model):
+ model = build(provider, "local-model", api_key="explicit-key")
+ assert model.kwargs["api_key"] == "explicit-key"
+
+
def test_openai_compatible_embedding_keeps_gateway_model_string(monkeypatch):
"""Gateway model ids must reach LiteLLM with an explicit `openai/` provider.