feat: introduce MCP server, cross-platform runtime, and Showcase UI reorganization
- Showcase UI Reorganization: * Move web UI dashboard from root directory into apps/showcase_ui/ for cleaner project structure * Add 'artemis ui' CLI command (artemis/interfaces/cli/commands/ui.py) and launcher scripts for the interactive showcase console - Standalone MCP Server & Notifiers (mcp_server/): * Implement dedicated MCP server package with mobile automation tools (device_state, inspect_trace, task_manager, task_runner) * Add multi-channel notifiers (AgentAPI, Desktop notifications, Webhooks, File output, and Composite routing) * Introduce background task runner and trace store for autonomous mobile execution monitoring - Cross-Platform Runtime & Toolchain Support: * Add artemis/platform/ with OS-specific implementations for Linux, macOS (Darwin), and Windows * Add artemis/runtime/supervisor.py for resilient process and agent runtime supervision * Add artemis/toolchain/ with dependency resolution and SDK descriptors * Add cross-platform launcher scripts (start.sh, start.bat) and installer scripts (scripts/install_deps.*) - Core Enhancements & Diagnostics: * Enhance coordinate normalization, OCR API fallback, and perception pipeline * Add credential validation (credentials_validator.py) and system diagnostics * Update bilingual documentation (README.md, README_CN.md) and architecture diagrams - Test Suite Expansion: * Add integration tests for cloud gateway, remote ADB, and Artemis login * Add unit tests covering core diagnostics, platform detection, toolchain, credentials validator, optional OCR, and MCP tools
This commit is contained in:
somew1nd committed
1 parent
78e478f502
commit
9a5aaf99b7
249 files changed
+37226
-9339
No files matched your search
@@ -0,0 +1,348 @@
|
||||
# Copyright 2026 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
"""System Readiness & Diagnostics Router for Artemis Admin Console."""
|
||||
|
||||
from fastapi import APIRouter, HTTPException
|
||||
from pydantic import BaseModel, Field
|
||||
|
||||
from artemis.core.diagnostics import readiness_engine
|
||||
from artemis.core.diagnostics.schema import SystemReadinessReport
|
||||
|
||||
router = APIRouter(prefix="/api/system", tags=["system"])
|
||||
|
||||
|
||||
class SelectDeviceRequest(BaseModel):
|
||||
"""Payload to select an active target Android device."""
|
||||
|
||||
serial: str = Field(description="Serial number or identifier of the Android device to select")
|
||||
|
||||
|
||||
@router.get("/readiness", response_model=SystemReadinessReport)
|
||||
async def get_system_readiness() -> SystemReadinessReport:
|
||||
"""Execute all diagnostic probes and return a comprehensive system readiness report."""
|
||||
return await readiness_engine.run_all()
|
||||
|
||||
|
||||
@router.post("/devices/select")
|
||||
async def select_active_device(request: SelectDeviceRequest):
|
||||
"""Select the active Android device or emulator for subsequent automated tasks."""
|
||||
serial = request.serial.strip()
|
||||
if not serial:
|
||||
raise HTTPException(status_code=400, detail="Device serial cannot be empty.")
|
||||
|
||||
readiness_engine.set_active_device_serial(serial)
|
||||
# Return updated readiness
|
||||
report = await readiness_engine.run_all()
|
||||
return {
|
||||
"status": "success",
|
||||
"selected_serial": serial,
|
||||
"report": report,
|
||||
}
|
||||
|
||||
|
||||
@router.post("/adb/restart")
|
||||
async def restart_adb_server():
|
||||
"""Restart local ADB server and return an updated readiness check."""
|
||||
restart_result = await readiness_engine.restart_adb_server()
|
||||
updated_report = await readiness_engine.run_all()
|
||||
return {
|
||||
"restart_result": restart_result,
|
||||
"report": updated_report,
|
||||
}
|
||||
|
||||
|
||||
class ConnectAdbRequest(BaseModel):
|
||||
"""Payload to connect to an Android device over Wi-Fi."""
|
||||
|
||||
host: str = Field(description="IP address of Android device")
|
||||
port: int = Field(default=5555, description="Port number")
|
||||
|
||||
|
||||
@router.post("/adb/connect")
|
||||
async def connect_wireless_adb(request: ConnectAdbRequest):
|
||||
"""Connect to a device over Wi-Fi and return updated readiness."""
|
||||
connect_result = await readiness_engine.connect_wireless_adb(request.host, request.port)
|
||||
updated_report = await readiness_engine.run_all()
|
||||
return {
|
||||
"connect_result": connect_result,
|
||||
"report": updated_report,
|
||||
}
|
||||
|
||||
|
||||
class LaunchEmulatorRequest(BaseModel):
|
||||
"""Payload to launch a local Android Virtual Device (AVD)."""
|
||||
|
||||
avd_name: str = Field(
|
||||
description="Name of the installed AVD emulator to launch (e.g. Android_2)"
|
||||
)
|
||||
|
||||
|
||||
@router.post("/emulator/launch")
|
||||
async def launch_emulator(request: LaunchEmulatorRequest):
|
||||
"""Launch an Android emulator in the background and return initiation status."""
|
||||
avd_name = request.avd_name.strip()
|
||||
if not avd_name:
|
||||
raise HTTPException(status_code=400, detail="AVD name cannot be empty.")
|
||||
|
||||
launch_res = await readiness_engine.launch_emulator(avd_name)
|
||||
return launch_res
|
||||
|
||||
|
||||
@router.get("/emulator/status")
|
||||
async def get_emulator_status():
|
||||
"""Query real-time progress and logs of background emulator launch."""
|
||||
return readiness_engine.get_emulator_status()
|
||||
|
||||
|
||||
@router.post("/emulator/stop")
|
||||
async def stop_emulator():
|
||||
"""Stop active emulator process."""
|
||||
return await readiness_engine.stop_emulator()
|
||||
|
||||
|
||||
@router.post("/emulator/dismiss")
|
||||
async def dismiss_emulator():
|
||||
"""Dismiss emulator launch tracking state."""
|
||||
return readiness_engine.dismiss_emulator()
|
||||
|
||||
|
||||
class UpdateCredentialsRequest(BaseModel):
|
||||
"""Payload to update and configure LLM or Vision OCR API credentials."""
|
||||
|
||||
provider: str = Field(
|
||||
default="google",
|
||||
description="Provider identifier (e.g. google, gemini, openai, anthropic, openrouter, ocr)",
|
||||
)
|
||||
api_key: str = Field(description="The secret API key string to configure")
|
||||
persist_to_env: bool = Field(
|
||||
default=True, description="Whether to persist the key to .env file"
|
||||
)
|
||||
|
||||
|
||||
class ValidateCredentialsRequest(BaseModel):
|
||||
"""Payload to test and verify LLM or Vision OCR API credentials without saving."""
|
||||
|
||||
provider: str = Field(
|
||||
default="google",
|
||||
description="Provider identifier (e.g. google, gemini, openai, anthropic, openrouter, ocr)",
|
||||
)
|
||||
api_key: str = Field(description="The secret API key string to test")
|
||||
base_url: str | None = Field(default=None, description="Optional custom base URL")
|
||||
|
||||
|
||||
@router.get("/credentials")
|
||||
async def get_credentials():
|
||||
"""Retrieve current configured API keys for management."""
|
||||
from artemis.config import settings
|
||||
|
||||
gemini_k = settings.get_api_key("google")
|
||||
openai_k = settings.get_api_key("openai")
|
||||
anthropic_k = settings.get_api_key("anthropic")
|
||||
openrouter_k = settings.get_api_key("openrouter")
|
||||
ocr_k = settings.get_api_key("ocr")
|
||||
return {
|
||||
"google": gemini_k.get_secret_value() if gemini_k else None,
|
||||
"gemini": gemini_k.get_secret_value() if gemini_k else None,
|
||||
"openai": openai_k.get_secret_value() if openai_k else None,
|
||||
"anthropic": anthropic_k.get_secret_value() if anthropic_k else None,
|
||||
"openrouter": openrouter_k.get_secret_value() if openrouter_k else None,
|
||||
"ocr": ocr_k.get_secret_value() if ocr_k else None,
|
||||
}
|
||||
|
||||
|
||||
@router.post("/credentials/test")
|
||||
async def test_credentials(request: ValidateCredentialsRequest):
|
||||
"""Test and verify whether an API key is valid and usable with the corresponding provider endpoint."""
|
||||
from artemis.utils.credentials_validator import validate_api_key
|
||||
|
||||
provider = request.provider.strip().lower()
|
||||
key = request.api_key.strip()
|
||||
|
||||
if not key:
|
||||
raise HTTPException(status_code=400, detail="API key cannot be empty.")
|
||||
|
||||
is_valid, message = await validate_api_key(
|
||||
provider=provider,
|
||||
api_key=key,
|
||||
base_url=request.base_url,
|
||||
)
|
||||
if not is_valid:
|
||||
raise HTTPException(status_code=400, detail=message)
|
||||
|
||||
return {
|
||||
"valid": True,
|
||||
"provider": provider,
|
||||
"message": message,
|
||||
}
|
||||
|
||||
|
||||
@router.post("/credentials")
|
||||
async def update_credentials(request: UpdateCredentialsRequest):
|
||||
"""Dynamically configure and persist LLM or Vision API key, returning updated readiness report."""
|
||||
from artemis.utils.credentials_validator import validate_api_key
|
||||
|
||||
provider = request.provider.strip().lower()
|
||||
key = request.api_key.strip()
|
||||
|
||||
# If a non-empty key is provided, verify it before saving
|
||||
if key:
|
||||
is_valid, validation_msg = await validate_api_key(provider=provider, api_key=key)
|
||||
if not is_valid:
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail=f"API key verification failed: {validation_msg}",
|
||||
)
|
||||
|
||||
try:
|
||||
from artemis.config import settings
|
||||
|
||||
settings.set_api_key(provider, key, persist_to_env=request.persist_to_env)
|
||||
|
||||
# Re-run all diagnostic probes to build updated report
|
||||
updated_report = await readiness_engine.run_all()
|
||||
action_desc = (
|
||||
"successfully verified, updated, and applied" if key else "successfully cleared"
|
||||
)
|
||||
return {
|
||||
"status": "success",
|
||||
"message": f"API key for {provider} {action_desc}.",
|
||||
"provider": provider,
|
||||
"report": updated_report,
|
||||
}
|
||||
except HTTPException:
|
||||
raise
|
||||
except Exception as exc:
|
||||
raise HTTPException(status_code=500, detail=f"Failed to update credentials: {exc}")
|
||||
|
||||
|
||||
@router.get("/model-config-env")
|
||||
async def get_model_config_and_env():
|
||||
"""Retrieve the current active artemis.jsonc configuration and .env status for custom setup."""
|
||||
import os
|
||||
from artemis.config.paths import ROOT_DIR, get_config_path
|
||||
from artemis.config import settings
|
||||
from artemis.utils.file import load_jsonc
|
||||
|
||||
from artemis.config.settings import is_placeholder_key
|
||||
|
||||
# 1. Config file resolution
|
||||
config_path = None
|
||||
config_content = ""
|
||||
parsed_config = {}
|
||||
try:
|
||||
config_path_obj = get_config_path("artemis.jsonc")
|
||||
config_path = str(config_path_obj)
|
||||
config_content = config_path_obj.read_text(encoding="utf-8")
|
||||
with open(config_path_obj, encoding="utf-8") as f:
|
||||
parsed_config = load_jsonc(f)
|
||||
except Exception as e:
|
||||
config_content = f"// Error reading config: {e}"
|
||||
|
||||
# 2. Env file resolution
|
||||
env_path = ROOT_DIR / ".env"
|
||||
|
||||
# 3. Relevant Env Variables status
|
||||
def get_real_env_value(key_name: str, provider: str) -> str | None:
|
||||
k = settings.get_api_key(provider)
|
||||
if k and not is_placeholder_key(k):
|
||||
return k.get_secret_value()
|
||||
val = os.environ.get(key_name)
|
||||
if val and val.strip() and not is_placeholder_key(val):
|
||||
return val.strip()
|
||||
return None
|
||||
|
||||
def mask_key(k: str | None) -> str | None:
|
||||
if not k:
|
||||
return None
|
||||
if len(k) <= 8:
|
||||
return "****"
|
||||
return f"{k[:4]}...{k[-4:]}"
|
||||
|
||||
gemini_real = get_real_env_value("GEMINI_API_KEY", "google") or get_real_env_value(
|
||||
"GOOGLE_API_KEY", "google"
|
||||
)
|
||||
openai_real = get_real_env_value("OPENAI_API_KEY", "openai")
|
||||
anthropic_real = get_real_env_value("ANTHROPIC_API_KEY", "anthropic")
|
||||
openrouter_real = get_real_env_value("OPEN_ROUTER_API_KEY", "openrouter")
|
||||
xai_real = get_real_env_value("XAI_API_KEY", "xai")
|
||||
base_url_val = settings.OPENAI_BASE_URL or os.environ.get("OPENAI_BASE_URL")
|
||||
if base_url_val and is_placeholder_key(base_url_val):
|
||||
base_url_val = None
|
||||
ocr_real = get_real_env_value("OCR_API_KEY", "ocr") or get_real_env_value(
|
||||
"VISION_API_KEY", "ocr"
|
||||
)
|
||||
|
||||
env_vars = [
|
||||
{
|
||||
"name": "GEMINI_API_KEY",
|
||||
"provider": "google",
|
||||
"is_set": bool(gemini_real),
|
||||
"preview": mask_key(gemini_real),
|
||||
"description": "Google Gemini multimodal vision API key (free tier available)",
|
||||
},
|
||||
{
|
||||
"name": "OPENAI_API_KEY",
|
||||
"provider": "openai",
|
||||
"is_set": bool(openai_real),
|
||||
"preview": mask_key(openai_real),
|
||||
"description": "OpenAI API key (GPT-4o, GPT-4o-mini)",
|
||||
},
|
||||
{
|
||||
"name": "ANTHROPIC_API_KEY",
|
||||
"provider": "anthropic",
|
||||
"is_set": bool(anthropic_real),
|
||||
"preview": mask_key(anthropic_real),
|
||||
"description": "Anthropic Claude API key (Claude 3.5 Sonnet, Claude 3.7)",
|
||||
},
|
||||
{
|
||||
"name": "OPEN_ROUTER_API_KEY",
|
||||
"provider": "openrouter",
|
||||
"is_set": bool(openrouter_real),
|
||||
"preview": mask_key(openrouter_real),
|
||||
"description": "OpenRouter unified API gateway key",
|
||||
},
|
||||
{
|
||||
"name": "XAI_API_KEY",
|
||||
"provider": "xai",
|
||||
"is_set": bool(xai_real),
|
||||
"preview": mask_key(xai_real),
|
||||
"description": "xAI Grok vision API key",
|
||||
},
|
||||
{
|
||||
"name": "OPENAI_BASE_URL",
|
||||
"provider": "custom",
|
||||
"is_set": bool(base_url_val),
|
||||
"preview": base_url_val,
|
||||
"description": "Custom API endpoint (for local Ollama, vLLM, DeepSeek, or proxies)",
|
||||
},
|
||||
{
|
||||
"name": "VISION_API_KEY",
|
||||
"provider": "ocr",
|
||||
"is_set": bool(ocr_real),
|
||||
"preview": mask_key(ocr_real),
|
||||
"description": "Google Cloud Vision OCR key for screen text detection (optional)",
|
||||
},
|
||||
]
|
||||
|
||||
return {
|
||||
"config_path": config_path or "config/artemis.jsonc",
|
||||
"config_filename": "artemis.jsonc",
|
||||
"config_content": config_content,
|
||||
"default_model": parsed_config.get("default", {}),
|
||||
"presets": parsed_config.get("presets", {}),
|
||||
"env_path": str(env_path),
|
||||
"env_filename": ".env",
|
||||
"env_vars": env_vars,
|
||||
}
|
||||
Reference in new issue
Block a user