Merge pull request #55 from zhujian0805/main

Migrate Droid BYOK config to settings.json customModels format

Author: zhujian0805

code_assistant_manager/tools.yaml

@@ -214,7 +214,7 @@ tools:
       injected: []
     filesystem:
       generated:
-        - "~/.factory/settings.json containing custom_models entries with base_url, api_key, provider, and max_tokens"
+        - "~/.factory/settings.json containing customModels entries with displayName, model, baseUrl, apiKey, provider, and maxOutputTokens"
 
   iflow:
     enabled: true

code_assistant_manager/tools/droid.py

@@ -72,21 +72,25 @@ def _process_endpoint(self, endpoint_name: str) -> Optional[List[str]]:
                 return None
 
         # Build entries for each selected model
+        api_key_env = str(endpoint_config.get("api_key_env", "")).strip()
+        api_key_value = (
+            f"${{{api_key_env}}}" if api_key_env else endpoint_config["actual_api_key"]
+        )
         entries = []
         for model in selected_models:
             display_name = f"{model} [{endpoint_name}]"
-            entry = f"{display_name}|{endpoint_config['endpoint']}|{endpoint_config['actual_api_key']}|generic-chat-completion-api|65536"
+            entry = f"{display_name}|{endpoint_config['endpoint']}|{api_key_value}|generic-chat-completion-api|65536"
             entries.append(entry)
 
         return entries
 
     def _write_droid_settings(self, selected_entries: List[str]) -> Path:
-        """Persist Droid custom models to ~/.factory/config.json."""
+        """Persist Droid custom models to ~/.factory/settings.json."""
         config_dir = Path.home() / ".factory"
-        config_file = config_dir / "config.json"
+        config_file = config_dir / "settings.json"
         config_dir.mkdir(parents=True, exist_ok=True)
 
-        # Preserve existing settings (plugins, etc) and only update custom_models.
+        # Preserve existing settings (plugins, etc) and only update customModels.
         settings: dict = {}
         if config_file.exists():
             try:
@@ -98,7 +102,7 @@ def _write_droid_settings(self, selected_entries: List[str]) -> Path:
         json_models = self._build_models_json(selected_entries)
 
         # Canonical location for Droid BYOK custom models.
-        settings["custom_models"] = json_models
+        settings["customModels"] = json_models
 
         with open(config_file, "w", encoding="utf-8") as f:
             json.dump(settings, f, indent=2)
@@ -131,7 +135,7 @@ def run(self, args: List[str] = None) -> int:
         - Loads environment variables
         - Ensures required commands are available
         - Aggregates selected models from configured endpoints
-        - Writes custom_models to ~/.factory/config.json and runs the `droid` CLI
+        - Writes customModels to ~/.factory/settings.json and runs the `droid` CLI
 
         Args:
             args: List of arguments to pass to the Droid CLI
@@ -178,7 +182,7 @@ def run(self, args: List[str] = None) -> int:
 
         print(f"Total models selected: {len(selected_entries)}\n")
 
-        # Persist Droid custom models to ~/.factory/config.json
+        # Persist Droid custom models to ~/.factory/settings.json
         settings_file = self._write_droid_settings(selected_entries)
         print(f"Droid settings written to {settings_file}\n")
 
@@ -201,26 +205,26 @@ def run(self, args: List[str] = None) -> int:
         return self._run_tool_with_env(command, env, "droid", interactive=True)
 
     def _build_models_json(self, entries: List[str]) -> List[dict]:
-        """Build models JSON from pipe-delimited entries (compat with legacy implementation)."""
+        """Build models JSON from pipe-delimited entries for Droid settings.json."""
         models: List[dict] = []
         for entry in entries:
             parts = entry.split("|")
             if len(parts) < 5:
                 continue
-            display, base_url, api_key, _provider, max_tokens = parts[:5]
+            display, base_url, api_key, provider, max_tokens = parts[:5]
             model_id = display.split("[")[0].strip()
             try:
                 max_tokens_val = int(max_tokens)
             except ValueError:
                 max_tokens_val = 0
             models.append(
                 {
-                    "model_display_name": display,
+                    "displayName": display,
                     "model": model_id,
-                    "base_url": base_url,
-                    "api_key": api_key,
-                    "provider": "generic-chat-completion-api",
-                    "max_tokens": max_tokens_val,
+                    "baseUrl": base_url,
+                    "apiKey": api_key,
+                    "provider": provider or "generic-chat-completion-api",
+                    "maxOutputTokens": max_tokens_val,
                 }
             )
         return models

docs/TOOLS_IMPLEMENTATION_COMPLETE.md

@@ -40,7 +40,7 @@ The Code Assistant Manager Python package now has complete implementations for a
 - Optional upgrade to latest version
 - Multi-endpoint model configuration
 - Generates ~/.factory/settings.json with selected models
-- JSON format: custom_models array with model display names, base URLs, API keys, providers, max tokens
+- JSON format: customModels array with displayName, model, baseUrl, apiKey, provider, maxOutputTokens
 - Per-endpoint model selection (with skip option)
 
 #### 6. **CopilotTool** ✅

tests/test_tools.py

@@ -192,8 +192,28 @@ def test_droid_build_models_json(self, config_manager):
         models = tool._build_models_json(entries)
         assert len(models) == 2
         assert models[0]["model"] == "model1"
-        assert models[0]["base_url"] == "https://api.com"
-        assert models[1]["max_tokens"] == 65536
+        assert models[0]["baseUrl"] == "https://api.com"
+        assert models[1]["maxOutputTokens"] == 65536
+
+    @patch.dict(os.environ, {"CODE_ASSISTANT_MANAGER_NONINTERACTIVE": "1"})
+    def test_droid_process_endpoint_prefers_api_key_env_reference(self, config_manager):
+        """Test Droid entries use ${API_KEY_ENV} in settings.json-compatible output when available."""
+        tool = DroidTool(config_manager)
+        tool.endpoint_manager = MagicMock()
+        tool.endpoint_manager.get_endpoint_config.return_value = (
+            True,
+            {
+                "endpoint": "https://api.example.com",
+                "actual_api_key": "raw-key",
+                "api_key_env": "FACTORY_TEST_KEY",
+            },
+        )
+        tool.endpoint_manager.fetch_models.return_value = (True, ["model1"])
+
+        entries = tool._process_endpoint("endpoint1")
+        assert entries is not None
+        assert len(entries) == 1
+        assert "${FACTORY_TEST_KEY}" in entries[0]
 
     @patch("code_assistant_manager.tools.subprocess.run")
     @patch("code_assistant_manager.tools.select_model")