mirror of
https://github.com/All-Hands-AI/OpenHands.git
synced 2026-04-29 03:00:45 -04:00
Compare commits
4 Commits
fix/git-ap
...
jps/custom
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
635a29a47c | ||
|
|
9f04705b30 | ||
|
|
d9b6901785 | ||
|
|
39c240527c |
836
doc/design-doc/custom-agent-s1.md
Normal file
836
doc/design-doc/custom-agent-s1.md
Normal file
@@ -0,0 +1,836 @@
|
||||
# Custom Agent Packages with Custom Runtime Images (Scenario 1)
|
||||
|
||||
## 1. Introduction
|
||||
|
||||
### 1.1 Problem Statement
|
||||
|
||||
OpenHands currently supports agent customization through the software-agent-sdk, but users who need custom system dependencies, specialized tools, or non-Python runtime environments cannot easily deploy their agents. The current V1 architecture uses a fixed agent server image (`ghcr.io/openhands/agent-server:5f62cee-python`) that may not contain the required dependencies for specialized agents.
|
||||
|
||||
Users building agents that require:
|
||||
- Custom system packages (e.g., specialized compilers, databases, ML frameworks)
|
||||
- Non-Python tools and runtimes (e.g., Node.js, Go, Rust toolchains)
|
||||
- Custom Docker base images with specific OS configurations
|
||||
- Proprietary or licensed software installations
|
||||
|
||||
Currently have no supported path to deploy their agents to OpenHands Enterprise.
|
||||
|
||||
### 1.2 Proposed Solution
|
||||
|
||||
We propose extending the existing **Sandbox Specification System** to support custom agent runtime images with proper permissions and security controls. This approach builds directly on OpenHands' current sandbox infrastructure rather than creating parallel systems.
|
||||
|
||||
Users will be able to:
|
||||
1. Create custom Docker images containing their agent code and dependencies
|
||||
2. Register these images as enhanced sandbox specifications with rich metadata
|
||||
3. Deploy conversations using their custom sandbox specs (with proper permissions)
|
||||
4. Maintain full compatibility with existing sandbox management and API infrastructure
|
||||
|
||||
The solution extends the current `SandboxSpecService` with:
|
||||
- **Permission-based access control** to limit custom specs to authorized users
|
||||
- **Enhanced sandbox specifications** that include agent-specific metadata and requirements
|
||||
- **Secure image management** with validation and approval workflows
|
||||
- **Integrated deployment** through existing conversation creation APIs
|
||||
|
||||
**Trade-offs**: This approach requires users to build and maintain Docker images, increasing complexity compared to simple Python package deployment. However, it provides the necessary isolation and dependency management for complex agent requirements while leveraging proven sandbox infrastructure.
|
||||
|
||||
## 2. User Interface
|
||||
|
||||
### 2.1 Custom Agent Image Creation
|
||||
|
||||
Users create a custom agent image by extending the base agent server image:
|
||||
|
||||
```dockerfile
|
||||
# Dockerfile for custom agent
|
||||
FROM ghcr.io/openhands/agent-server:5f62cee-python
|
||||
|
||||
# Install custom system dependencies
|
||||
RUN apt-get update && apt-get install -y \
|
||||
nodejs \
|
||||
npm \
|
||||
golang-go \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Install custom Python packages
|
||||
COPY requirements.txt /tmp/
|
||||
RUN pip install -r /tmp/requirements.txt
|
||||
|
||||
# Copy custom agent code
|
||||
COPY my_custom_agent/ /app/my_custom_agent/
|
||||
COPY agent_config.json /app/config/
|
||||
|
||||
# Set custom agent as default
|
||||
ENV CUSTOM_AGENT_MODULE=my_custom_agent
|
||||
ENV CUSTOM_AGENT_CLASS=MySpecializedAgent
|
||||
```
|
||||
|
||||
### 2.2 Enhanced Sandbox Spec Registration
|
||||
|
||||
Users register their custom agent image as an enhanced sandbox specification:
|
||||
|
||||
```yaml
|
||||
# enhanced-sandbox-spec.yaml
|
||||
apiVersion: openhands.ai/v1
|
||||
kind: SandboxSpec
|
||||
metadata:
|
||||
name: specialized-ml-agent
|
||||
version: "1.0.0"
|
||||
owner: user@company.com
|
||||
permissions:
|
||||
users: ["user@company.com", "team-lead@company.com"]
|
||||
groups: ["ml-team", "data-science"]
|
||||
spec:
|
||||
image: "myregistry/specialized-ml-agent:v1.0.0"
|
||||
description: "ML agent with TensorFlow and custom data processing tools"
|
||||
# Agent-specific metadata
|
||||
agent:
|
||||
capabilities:
|
||||
- machine_learning
|
||||
- data_analysis
|
||||
- custom_visualization
|
||||
type: "custom"
|
||||
module: "agents.specialized_ml_agent"
|
||||
class: "SpecializedMLAgent"
|
||||
requirements:
|
||||
memory: "4Gi"
|
||||
cpu: "2"
|
||||
environment:
|
||||
TENSORFLOW_VERSION: "2.15.0"
|
||||
CUSTOM_MODEL_PATH: "/app/models"
|
||||
# Agent server configuration
|
||||
CUSTOM_AGENT_MODULE: "agents.specialized_ml_agent"
|
||||
CUSTOM_AGENT_CLASS: "SpecializedMLAgent"
|
||||
ports:
|
||||
- name: agent-server
|
||||
port: 8000
|
||||
- name: tensorboard
|
||||
port: 6006
|
||||
```
|
||||
|
||||
### 2.3 Conversation Creation with Custom Sandbox Spec
|
||||
|
||||
Users create conversations using their custom sandbox specs through the existing API:
|
||||
|
||||
```bash
|
||||
# Create conversation with custom sandbox spec
|
||||
curl -X POST "https://api.openhands.ai/api/conversations" \
|
||||
-H "Authorization: Bearer $API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"sandbox_spec_id": "specialized-ml-agent:v1.0.0",
|
||||
"initial_message": "Analyze this dataset and create a predictive model",
|
||||
"workspace": {
|
||||
"type": "local",
|
||||
"working_dir": "/workspace/ml-project"
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
### 2.4 Image Management Workflows
|
||||
|
||||
#### 2.4.1 Pre-built Image Approach
|
||||
|
||||
For organizations that want to manage custom agent images centrally:
|
||||
|
||||
```bash
|
||||
# Admin registers pre-built image as sandbox spec
|
||||
curl -X POST "https://api.openhands.ai/api/sandbox-specs" \
|
||||
-H "Authorization: Bearer $ADMIN_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"name": "company-ml-agent",
|
||||
"version": "1.0.0",
|
||||
"image": "company-registry/ml-agent:v1.0.0",
|
||||
"permissions": {
|
||||
"groups": ["ml-team", "data-science"]
|
||||
},
|
||||
"agent": {
|
||||
"type": "custom",
|
||||
"capabilities": ["machine_learning", "data_analysis"]
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
#### 2.4.2 User Upload Approach
|
||||
|
||||
For users who want to upload their own custom images:
|
||||
|
||||
```bash
|
||||
# User uploads custom image (with security validation)
|
||||
curl -X POST "https://api.openhands.ai/api/sandbox-specs/upload" \
|
||||
-H "Authorization: Bearer $API_KEY" \
|
||||
-F "dockerfile=@Dockerfile" \
|
||||
-F "context=@agent-context.tar.gz" \
|
||||
-F "spec=@sandbox-spec.yaml"
|
||||
```
|
||||
|
||||
## 3. Other Context
|
||||
|
||||
### 3.1 Current Sandbox Specification System
|
||||
|
||||
OpenHands V1 uses a sandbox specification system to manage container deployments:
|
||||
|
||||
- **Single Default Spec**: Currently only one sandbox spec exists, shared by all users
|
||||
- **SandboxSpecService**: Manages sandbox specifications and container creation
|
||||
- **SandboxSpecInfo**: Contains image, environment, and resource configuration
|
||||
- **No Permissions**: Current system lacks user-based access control
|
||||
|
||||
The existing system provides the foundation but needs enhancement for custom agents:
|
||||
- **Permission Layer**: Required to control access to custom specs
|
||||
- **Rich Metadata**: Need agent-specific information beyond basic container config
|
||||
- **Image Management**: Need secure workflows for custom image registration
|
||||
|
||||
### 3.2 Enhanced Sandbox Specification Architecture
|
||||
|
||||
Our proposal extends the existing system with:
|
||||
|
||||
#### 3.2.1 Permission-Based Access Control
|
||||
- **User Permissions**: Individual user access to specific sandbox specs
|
||||
- **Group Permissions**: Team-based access control for organizational specs
|
||||
- **Owner Management**: Spec ownership and delegation capabilities
|
||||
- **Admin Override**: Administrative access for spec management
|
||||
|
||||
#### 3.2.2 Agent-Specific Metadata
|
||||
- **Agent Configuration**: Module, class, and capability information
|
||||
- **Resource Requirements**: Memory, CPU, and storage specifications
|
||||
- **Environment Variables**: Agent-specific configuration and secrets
|
||||
- **Port Mappings**: Additional ports for agent services (e.g., TensorBoard)
|
||||
|
||||
#### 3.2.3 Image Management Integration
|
||||
- **Registry Support**: Integration with Docker registries for image storage
|
||||
- **Security Validation**: Image scanning and approval workflows
|
||||
- **Version Management**: Support for multiple versions of custom specs
|
||||
- **Build Integration**: Optional image building from Dockerfile uploads
|
||||
|
||||
### 3.3 Existing Container Orchestration Integration
|
||||
|
||||
The enhanced system leverages existing OpenHands infrastructure:
|
||||
|
||||
- **Sandbox Service**: Extended to support permission checks and enhanced specs
|
||||
- **Container Management**: Same lifecycle management with additional metadata
|
||||
- **Network Isolation**: Maintains existing security boundaries
|
||||
- **Resource Enforcement**: Enhanced with custom resource requirements
|
||||
- **Health Monitoring**: Extended to track custom agent-specific metrics
|
||||
|
||||
## 4. Technical Design
|
||||
|
||||
### 4.1 Enhanced Sandbox Specification Model
|
||||
|
||||
#### 4.1.1 Extended SandboxSpecInfo Structure
|
||||
|
||||
The existing `SandboxSpecInfo` model is enhanced to support custom agents:
|
||||
|
||||
```python
|
||||
# openhands/app_server/sandbox/sandbox_spec_models.py (enhanced)
|
||||
from pydantic import BaseModel, Field
|
||||
from typing import Dict, List, Optional
|
||||
|
||||
class AgentMetadata(BaseModel):
|
||||
"""Agent-specific metadata for custom agents."""
|
||||
type: str = Field(default="default", description="Agent type (default|custom)")
|
||||
capabilities: List[str] = Field(default_factory=list, description="Agent capabilities")
|
||||
module: Optional[str] = Field(description="Python module containing agent class")
|
||||
class_name: Optional[str] = Field(description="Agent class name")
|
||||
|
||||
class PermissionSpec(BaseModel):
|
||||
"""Permission specification for sandbox spec access."""
|
||||
users: List[str] = Field(default_factory=list, description="Authorized user emails")
|
||||
groups: List[str] = Field(default_factory=list, description="Authorized group names")
|
||||
owner: Optional[str] = Field(description="Spec owner")
|
||||
|
||||
class EnhancedSandboxSpecInfo(BaseModel):
|
||||
"""Enhanced sandbox specification with agent metadata and permissions."""
|
||||
|
||||
# Existing fields from SandboxSpecInfo
|
||||
id: str = Field(description="Docker image identifier")
|
||||
command: List[str] = Field(default_factory=lambda: ['--port', '8000'])
|
||||
initial_env: Dict[str, str] = Field(default_factory=dict)
|
||||
working_dir: str = Field(default="/workspace/project")
|
||||
|
||||
# Enhanced fields
|
||||
name: str = Field(description="Human-readable spec name")
|
||||
version: str = Field(description="Spec version")
|
||||
description: Optional[str] = Field(description="Spec description")
|
||||
|
||||
# Agent-specific metadata
|
||||
agent: AgentMetadata = Field(default_factory=AgentMetadata)
|
||||
|
||||
# Permission and access control
|
||||
permissions: PermissionSpec = Field(default_factory=PermissionSpec)
|
||||
|
||||
# Resource requirements
|
||||
memory_limit: Optional[str] = Field(description="Memory limit (e.g., '4Gi')")
|
||||
cpu_limit: Optional[str] = Field(description="CPU limit (e.g., '2')")
|
||||
|
||||
# Additional ports for custom services
|
||||
ports: List[Dict[str, any]] = Field(
|
||||
default_factory=lambda: [{"name": "agent-server", "port": 8000}]
|
||||
)
|
||||
```
|
||||
|
||||
#### 4.1.2 Custom Agent Image Structure
|
||||
|
||||
Custom agent images extend the base agent server with this structure:
|
||||
|
||||
```
|
||||
/app/
|
||||
├── config/
|
||||
│ ├── agent_config.json # Agent configuration
|
||||
│ └── tool_registry.json # Custom tool definitions (optional)
|
||||
├── agents/
|
||||
│ └── custom_agent.py # Agent implementation
|
||||
├── tools/ # Custom tools (optional)
|
||||
│ ├── __init__.py
|
||||
│ └── custom_tools.py
|
||||
└── startup/
|
||||
└── init_agent.py # Agent initialization script
|
||||
```
|
||||
|
||||
### 4.2 Agent Implementation Interface
|
||||
|
||||
#### 4.2.1 Custom Agent Base Class
|
||||
|
||||
```python
|
||||
# agents/custom_agent.py
|
||||
from openhands.sdk.agent.base import AgentBase
|
||||
from openhands.sdk.llm import LLM
|
||||
from openhands.sdk.tool import Tool
|
||||
from typing import List, Dict, Any
|
||||
|
||||
class SpecializedMLAgent(AgentBase):
|
||||
"""Custom ML agent with TensorFlow capabilities."""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
llm: LLM,
|
||||
tools: List[Tool],
|
||||
config: Dict[str, Any] = None
|
||||
):
|
||||
super().__init__(llm=llm, tools=tools)
|
||||
self.config = config or {}
|
||||
self.model_cache = self.config.get('MODEL_CACHE_DIR', '/app/models')
|
||||
|
||||
async def initialize(self) -> None:
|
||||
"""Initialize custom agent resources."""
|
||||
# Load pre-trained models
|
||||
await self._load_models()
|
||||
|
||||
# Initialize custom tools
|
||||
await self._setup_custom_tools()
|
||||
|
||||
async def _load_models(self) -> None:
|
||||
"""Load TensorFlow models from cache."""
|
||||
import tensorflow as tf
|
||||
# Custom model loading logic
|
||||
pass
|
||||
|
||||
async def _setup_custom_tools(self) -> None:
|
||||
"""Initialize custom tools with agent context."""
|
||||
# Custom tool setup logic
|
||||
pass
|
||||
```
|
||||
|
||||
#### 4.2.2 Custom Tool Implementation
|
||||
|
||||
```python
|
||||
# tools/custom_tools.py
|
||||
from openhands.sdk.tool import Tool, ToolExecutor, register_tool
|
||||
from openhands.sdk import Action, Observation
|
||||
from pydantic import Field
|
||||
import tensorflow as tf
|
||||
|
||||
class TensorFlowAnalysisAction(Action):
|
||||
dataset_path: str = Field(description="Path to dataset file")
|
||||
model_type: str = Field(description="Type of ML model to create")
|
||||
target_column: str = Field(description="Target column for prediction")
|
||||
|
||||
class TensorFlowAnalysisObservation(Observation):
|
||||
model_accuracy: float = Field(description="Model accuracy score")
|
||||
feature_importance: Dict[str, float] = Field(description="Feature importance scores")
|
||||
model_path: str = Field(description="Path to saved model")
|
||||
|
||||
class TensorFlowToolExecutor(ToolExecutor[TensorFlowAnalysisAction, TensorFlowAnalysisObservation]):
|
||||
def __call__(self, action: TensorFlowAnalysisAction, conversation=None) -> TensorFlowAnalysisObservation:
|
||||
# Custom TensorFlow analysis logic
|
||||
model = self._create_model(action.dataset_path, action.model_type, action.target_column)
|
||||
accuracy = self._evaluate_model(model)
|
||||
importance = self._get_feature_importance(model)
|
||||
model_path = self._save_model(model)
|
||||
|
||||
return TensorFlowAnalysisObservation(
|
||||
model_accuracy=accuracy,
|
||||
feature_importance=importance,
|
||||
model_path=model_path
|
||||
)
|
||||
|
||||
# Register the custom tool
|
||||
register_tool(
|
||||
Tool(
|
||||
name="TensorFlowTool",
|
||||
executor=TensorFlowToolExecutor(),
|
||||
definition=ToolDefinition(
|
||||
name="tensorflow_analysis",
|
||||
description="Perform machine learning analysis using TensorFlow",
|
||||
parameters=TensorFlowAnalysisAction.model_json_schema()
|
||||
)
|
||||
)
|
||||
)
|
||||
```
|
||||
|
||||
### 4.3 Runtime Integration
|
||||
|
||||
#### 4.3.1 Custom Agent Loader
|
||||
|
||||
```python
|
||||
# startup/init_agent.py
|
||||
import json
|
||||
import importlib
|
||||
from pathlib import Path
|
||||
from openhands.sdk.agent.base import AgentBase
|
||||
from openhands.sdk.llm import LLM
|
||||
from openhands.sdk.tool import Tool, resolve_tool
|
||||
|
||||
class CustomAgentLoader:
|
||||
"""Loads custom agents from configuration."""
|
||||
|
||||
def __init__(self, config_path: str = "/app/config/agent_config.json"):
|
||||
self.config_path = Path(config_path)
|
||||
self.config = self._load_config()
|
||||
|
||||
def _load_config(self) -> dict:
|
||||
"""Load agent configuration from JSON file."""
|
||||
with open(self.config_path) as f:
|
||||
return json.load(f)
|
||||
|
||||
def create_agent(self, llm: LLM) -> AgentBase:
|
||||
"""Create custom agent instance."""
|
||||
agent_config = self.config["agent"]
|
||||
|
||||
# Import custom agent class
|
||||
module = importlib.import_module(agent_config["module"])
|
||||
agent_class = getattr(module, agent_config["class"])
|
||||
|
||||
# Load custom tools
|
||||
tools = self._load_tools()
|
||||
|
||||
# Create agent instance
|
||||
agent = agent_class(
|
||||
llm=llm,
|
||||
tools=tools,
|
||||
config=self.config.get("environment", {})
|
||||
)
|
||||
|
||||
return agent
|
||||
|
||||
def _load_tools(self) -> List[Tool]:
|
||||
"""Load and resolve custom tools."""
|
||||
tools = []
|
||||
for tool_config in self.config.get("tools", []):
|
||||
if "module" in tool_config:
|
||||
# Import custom tool module to register it
|
||||
importlib.import_module(tool_config["module"])
|
||||
|
||||
tool = resolve_tool(tool_config["name"])
|
||||
tools.append(tool)
|
||||
|
||||
return tools
|
||||
```
|
||||
|
||||
#### 4.3.2 Agent Server Startup Integration
|
||||
|
||||
```python
|
||||
# Modified agent server startup in software-agent-sdk
|
||||
import os
|
||||
from openhands.agent_server.api import app
|
||||
from openhands.agent_server.conversation_service import ConversationService
|
||||
from startup.init_agent import CustomAgentLoader
|
||||
|
||||
@app.on_event("startup")
|
||||
async def startup_event():
|
||||
"""Initialize custom agent during server startup."""
|
||||
|
||||
# Check for custom agent configuration
|
||||
custom_agent_module = os.getenv('CUSTOM_AGENT_MODULE')
|
||||
custom_agent_class = os.getenv('CUSTOM_AGENT_CLASS')
|
||||
|
||||
if custom_agent_module and custom_agent_class:
|
||||
# Load custom agent
|
||||
loader = CustomAgentLoader()
|
||||
app.state.agent_factory = loader.create_agent
|
||||
print(f"Loaded custom agent: {custom_agent_class}")
|
||||
else:
|
||||
# Use default agent
|
||||
from openhands.sdk.agent import Agent
|
||||
app.state.agent_factory = lambda llm: Agent(llm=llm, tools=get_default_tools())
|
||||
print("Using default OpenHands agent")
|
||||
```
|
||||
|
||||
### 4.4 Enhanced Sandbox Service Integration
|
||||
|
||||
#### 4.4.1 Permission-Aware Sandbox Service
|
||||
|
||||
```python
|
||||
# openhands/app_server/sandbox/enhanced_sandbox_spec_service.py
|
||||
from openhands.app_server.sandbox.sandbox_spec_service import SandboxSpecService
|
||||
from openhands.app_server.sandbox.sandbox_spec_models import SandboxSpecInfo, EnhancedSandboxSpecInfo
|
||||
from typing import Dict, List, Optional
|
||||
|
||||
class EnhancedSandboxSpecService(SandboxSpecService):
|
||||
"""Enhanced sandbox service with permissions and custom agent support."""
|
||||
|
||||
def __init__(self, spec_registry: Dict[str, EnhancedSandboxSpecInfo]):
|
||||
super().__init__()
|
||||
self.spec_registry = spec_registry
|
||||
|
||||
def get_available_sandbox_specs(self, user_email: str, user_groups: List[str]) -> List[str]:
|
||||
"""Get sandbox specs available to the user based on permissions."""
|
||||
available_specs = []
|
||||
|
||||
for spec_key, spec in self.spec_registry.items():
|
||||
if self._has_permission(spec, user_email, user_groups):
|
||||
available_specs.append(spec_key)
|
||||
|
||||
return available_specs
|
||||
|
||||
def get_sandbox_spec_by_id(
|
||||
self,
|
||||
spec_id: str,
|
||||
user_email: str,
|
||||
user_groups: List[str]
|
||||
) -> SandboxSpecInfo:
|
||||
"""Get sandbox spec by ID with permission check."""
|
||||
|
||||
if spec_id not in self.spec_registry:
|
||||
# Fall back to default specs for backward compatibility
|
||||
return super().get_default_sandbox_specs()[0]
|
||||
|
||||
enhanced_spec = self.spec_registry[spec_id]
|
||||
|
||||
# Check permissions
|
||||
if not self._has_permission(enhanced_spec, user_email, user_groups):
|
||||
raise PermissionError(f"User {user_email} does not have access to spec {spec_id}")
|
||||
|
||||
# Convert to SandboxSpecInfo for existing infrastructure
|
||||
return self._convert_to_sandbox_spec_info(enhanced_spec)
|
||||
|
||||
def _has_permission(
|
||||
self,
|
||||
spec: EnhancedSandboxSpecInfo,
|
||||
user_email: str,
|
||||
user_groups: List[str]
|
||||
) -> bool:
|
||||
"""Check if user has permission to use the sandbox spec."""
|
||||
|
||||
# Owner always has access
|
||||
if spec.permissions.owner == user_email:
|
||||
return True
|
||||
|
||||
# Check user permissions
|
||||
if user_email in spec.permissions.users:
|
||||
return True
|
||||
|
||||
# Check group permissions
|
||||
for group in user_groups:
|
||||
if group in spec.permissions.groups:
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
def _convert_to_sandbox_spec_info(self, enhanced_spec: EnhancedSandboxSpecInfo) -> SandboxSpecInfo:
|
||||
"""Convert enhanced spec to standard SandboxSpecInfo."""
|
||||
|
||||
# Build environment variables including agent configuration
|
||||
env_vars = {
|
||||
'OPENVSCODE_SERVER_ROOT': '/openhands/.openvscode-server',
|
||||
'OH_ENABLE_VNC': '0',
|
||||
'LOG_JSON': 'true',
|
||||
'OH_CONVERSATIONS_PATH': '/workspace/conversations',
|
||||
'OH_BASH_EVENTS_DIR': '/workspace/bash_events',
|
||||
'PYTHONUNBUFFERED': '1',
|
||||
'ENV_LOG_LEVEL': '20',
|
||||
**enhanced_spec.initial_env
|
||||
}
|
||||
|
||||
# Add custom agent configuration if specified
|
||||
if enhanced_spec.agent.type == "custom":
|
||||
env_vars.update({
|
||||
'CUSTOM_AGENT_MODULE': enhanced_spec.agent.module,
|
||||
'CUSTOM_AGENT_CLASS': enhanced_spec.agent.class_name,
|
||||
})
|
||||
|
||||
return SandboxSpecInfo(
|
||||
id=enhanced_spec.id,
|
||||
command=enhanced_spec.command,
|
||||
initial_env=env_vars,
|
||||
working_dir=enhanced_spec.working_dir,
|
||||
)
|
||||
|
||||
def register_sandbox_spec(
|
||||
self,
|
||||
spec: EnhancedSandboxSpecInfo,
|
||||
admin_user: str
|
||||
) -> str:
|
||||
"""Register a new sandbox spec (admin only)."""
|
||||
|
||||
spec_key = f"{spec.name}:{spec.version}"
|
||||
|
||||
# Validate spec
|
||||
self._validate_sandbox_spec(spec)
|
||||
|
||||
# Store in registry
|
||||
self.spec_registry[spec_key] = spec
|
||||
|
||||
return spec_key
|
||||
|
||||
def _validate_sandbox_spec(self, spec: EnhancedSandboxSpecInfo) -> None:
|
||||
"""Validate sandbox spec for security and correctness."""
|
||||
|
||||
# Image validation
|
||||
if not spec.id or not spec.id.strip():
|
||||
raise ValueError("Image ID cannot be empty")
|
||||
|
||||
# Permission validation
|
||||
if not spec.permissions.owner:
|
||||
raise ValueError("Sandbox spec must have an owner")
|
||||
|
||||
# Agent validation for custom agents
|
||||
if spec.agent.type == "custom":
|
||||
if not spec.agent.module or not spec.agent.class_name:
|
||||
raise ValueError("Custom agents must specify module and class_name")
|
||||
```
|
||||
|
||||
### 4.5 Enhanced API Integration
|
||||
|
||||
#### 4.5.1 Enhanced Conversation Creation
|
||||
|
||||
```python
|
||||
# openhands/server/routes/conversation_routes.py (enhanced)
|
||||
from fastapi import APIRouter, HTTPException, Depends
|
||||
from pydantic import BaseModel
|
||||
from typing import Optional, Dict, Any, List
|
||||
from uuid import UUID
|
||||
|
||||
from openhands.app_server.sandbox.enhanced_sandbox_spec_service import EnhancedSandboxSpecService
|
||||
from openhands.server.session.agent_session import AgentSession
|
||||
from openhands.server.auth import get_current_user, get_user_groups
|
||||
|
||||
# Enhanced conversation creation request
|
||||
class CreateConversationRequest(BaseModel):
|
||||
initial_message: str
|
||||
workspace_config: Optional[Dict[str, Any]] = None
|
||||
# New field for custom sandbox spec
|
||||
sandbox_spec_id: Optional[str] = None
|
||||
|
||||
@router.post("/conversations")
|
||||
async def create_conversation(
|
||||
request: CreateConversationRequest,
|
||||
current_user: str = Depends(get_current_user),
|
||||
user_groups: List[str] = Depends(get_user_groups),
|
||||
sandbox_service: EnhancedSandboxSpecService = Depends(get_enhanced_sandbox_service)
|
||||
) -> ConversationResponse:
|
||||
"""Create conversation with optional custom sandbox spec."""
|
||||
|
||||
try:
|
||||
if request.sandbox_spec_id:
|
||||
# Use custom sandbox spec with permission check
|
||||
sandbox_spec = sandbox_service.get_sandbox_spec_by_id(
|
||||
request.sandbox_spec_id,
|
||||
current_user,
|
||||
user_groups
|
||||
)
|
||||
else:
|
||||
# Use default sandbox spec
|
||||
sandbox_spec = sandbox_service.get_default_sandbox_specs()[0]
|
||||
|
||||
# Create sandbox and conversation
|
||||
sandbox = await sandbox_service.create_sandbox(sandbox_spec)
|
||||
await wait_for_agent_server_ready(sandbox)
|
||||
|
||||
conversation = await create_conversation_with_sandbox(
|
||||
sandbox=sandbox,
|
||||
initial_message=request.initial_message,
|
||||
workspace_config=request.workspace_config
|
||||
)
|
||||
|
||||
return ConversationResponse(
|
||||
conversation_id=conversation.id,
|
||||
status="created",
|
||||
sandbox_spec_id=request.sandbox_spec_id or "default"
|
||||
)
|
||||
|
||||
except PermissionError as e:
|
||||
raise HTTPException(status_code=403, detail=str(e))
|
||||
except ValueError as e:
|
||||
raise HTTPException(status_code=404, detail=str(e))
|
||||
```
|
||||
|
||||
#### 4.5.2 Sandbox Spec Management API
|
||||
|
||||
```python
|
||||
# openhands/server/routes/sandbox_spec_routes.py (new)
|
||||
from fastapi import APIRouter, HTTPException, Depends, UploadFile, File
|
||||
from pydantic import BaseModel
|
||||
from typing import List, Optional
|
||||
import yaml
|
||||
|
||||
from openhands.app_server.sandbox.enhanced_sandbox_spec_service import EnhancedSandboxSpecService
|
||||
from openhands.app_server.sandbox.sandbox_spec_models import EnhancedSandboxSpecInfo
|
||||
from openhands.server.auth import get_current_user, get_user_groups, require_admin
|
||||
|
||||
router = APIRouter(prefix="/api/sandbox-specs", tags=["Sandbox Specs"])
|
||||
|
||||
@router.get("/")
|
||||
async def list_available_sandbox_specs(
|
||||
current_user: str = Depends(get_current_user),
|
||||
user_groups: List[str] = Depends(get_user_groups),
|
||||
sandbox_service: EnhancedSandboxSpecService = Depends(get_enhanced_sandbox_service)
|
||||
) -> List[str]:
|
||||
"""List sandbox specs available to the current user."""
|
||||
|
||||
return sandbox_service.get_available_sandbox_specs(current_user, user_groups)
|
||||
|
||||
@router.post("/")
|
||||
async def register_sandbox_spec(
|
||||
spec_data: EnhancedSandboxSpecInfo,
|
||||
current_user: str = Depends(require_admin),
|
||||
sandbox_service: EnhancedSandboxSpecService = Depends(get_enhanced_sandbox_service)
|
||||
) -> Dict[str, str]:
|
||||
"""Register a new sandbox spec (admin only)."""
|
||||
|
||||
try:
|
||||
spec_key = sandbox_service.register_sandbox_spec(spec_data, current_user)
|
||||
return {"spec_id": spec_key, "status": "registered"}
|
||||
except ValueError as e:
|
||||
raise HTTPException(status_code=400, detail=str(e))
|
||||
|
||||
@router.post("/upload")
|
||||
async def upload_custom_image(
|
||||
dockerfile: UploadFile = File(...),
|
||||
context: UploadFile = File(...),
|
||||
spec: UploadFile = File(...),
|
||||
current_user: str = Depends(get_current_user),
|
||||
sandbox_service: EnhancedSandboxSpecService = Depends(get_enhanced_sandbox_service)
|
||||
) -> Dict[str, str]:
|
||||
"""Upload custom image with Dockerfile and context (with security validation)."""
|
||||
|
||||
try:
|
||||
# Parse spec file
|
||||
spec_content = await spec.read()
|
||||
spec_data = yaml.safe_load(spec_content)
|
||||
|
||||
# Validate user has permission to create specs
|
||||
if not _can_user_create_specs(current_user):
|
||||
raise HTTPException(status_code=403, detail="User not authorized to create custom specs")
|
||||
|
||||
# Security validation of Dockerfile
|
||||
dockerfile_content = await dockerfile.read()
|
||||
_validate_dockerfile_security(dockerfile_content)
|
||||
|
||||
# Build image (implementation depends on build system)
|
||||
image_id = await _build_custom_image(dockerfile_content, context, current_user)
|
||||
|
||||
# Create enhanced spec
|
||||
enhanced_spec = EnhancedSandboxSpecInfo(**spec_data)
|
||||
enhanced_spec.id = image_id
|
||||
enhanced_spec.permissions.owner = current_user
|
||||
|
||||
# Register the spec
|
||||
spec_key = sandbox_service.register_sandbox_spec(enhanced_spec, current_user)
|
||||
|
||||
return {"spec_id": spec_key, "image_id": image_id, "status": "uploaded"}
|
||||
|
||||
except Exception as e:
|
||||
raise HTTPException(status_code=400, detail=f"Upload failed: {str(e)}")
|
||||
```
|
||||
|
||||
## 5. Implementation Plan
|
||||
|
||||
All implementation must pass existing lints and tests. New functionality requires comprehensive test coverage including unit tests, integration tests, and end-to-end scenarios.
|
||||
|
||||
### 5.1 Enhanced Sandbox Models and Permissions (M1)
|
||||
|
||||
#### 5.1.1 Enhanced Sandbox Specification Models
|
||||
|
||||
* `openhands/app_server/sandbox/sandbox_spec_models.py` (enhanced)
|
||||
* `tests/unit/app_server/sandbox/test_enhanced_sandbox_spec_models.py`
|
||||
|
||||
Extend existing `SandboxSpecInfo` with `EnhancedSandboxSpecInfo` including agent metadata, permissions, and resource requirements. This is the **core requirement** identified by the engineer.
|
||||
|
||||
#### 5.1.2 Permission System Foundation
|
||||
|
||||
* `openhands/server/auth/permissions.py`
|
||||
* `tests/unit/server/auth/test_permissions.py`
|
||||
|
||||
Implement user and group-based permission system for sandbox spec access control. This addresses the **security concerns** from V0 mentioned by the engineer.
|
||||
|
||||
**Demo**: Create enhanced sandbox specs with permission restrictions and verify access control works correctly.
|
||||
|
||||
### 5.2 Enhanced Sandbox Service (M2)
|
||||
|
||||
#### 5.2.1 Permission-Aware Sandbox Service
|
||||
|
||||
* `openhands/app_server/sandbox/enhanced_sandbox_spec_service.py`
|
||||
* `tests/unit/app_server/sandbox/test_enhanced_sandbox_spec_service.py`
|
||||
|
||||
Extend existing `SandboxSpecService` with permission checks and enhanced spec management. This **builds on existing infrastructure** as the engineer suggested.
|
||||
|
||||
#### 5.2.2 Agent Server Startup Integration
|
||||
|
||||
* `openhands-agent-server/openhands/agent_server/custom_agent_loader.py`
|
||||
* `tests/unit/agent_server/test_custom_agent_loader.py`
|
||||
|
||||
Implement custom agent loading mechanism in agent server startup process with configuration-driven agent instantiation.
|
||||
|
||||
**Demo**: Deploy custom agents using enhanced sandbox specs and verify permission-based access control works end-to-end.
|
||||
|
||||
### 5.3 Image Management and API Integration (M3)
|
||||
|
||||
#### 5.3.1 Secure Image Management
|
||||
|
||||
* `openhands/app_server/sandbox/image_builder.py`
|
||||
* `openhands/app_server/security/dockerfile_validator.py`
|
||||
* `tests/unit/app_server/sandbox/test_image_builder.py`
|
||||
* `tests/unit/app_server/security/test_dockerfile_validator.py`
|
||||
|
||||
Implement both **pre-built image registration** and **secure user upload** workflows as identified by the engineer. This addresses the security issues from V0.
|
||||
|
||||
#### 5.3.2 Enhanced Conversation API
|
||||
|
||||
* `openhands/server/routes/conversation_routes.py` (enhanced)
|
||||
* `openhands/server/routes/sandbox_spec_routes.py` (new)
|
||||
* `tests/unit/server/routes/test_enhanced_conversation_routes.py`
|
||||
* `tests/unit/server/routes/test_sandbox_spec_routes.py`
|
||||
|
||||
Enhance existing conversation creation API to support `sandbox_spec_id` parameter and add new sandbox spec management endpoints.
|
||||
|
||||
**Demo**: Create conversations with custom sandbox specs through existing API endpoints and demonstrate both pre-built and user-uploaded image workflows.
|
||||
|
||||
### 5.4 Advanced Security and Management (M4)
|
||||
|
||||
#### 5.4.1 Image Security Validation
|
||||
|
||||
* `openhands/app_server/security/image_scanner.py`
|
||||
* `openhands/app_server/security/security_policies.py`
|
||||
* `tests/unit/app_server/security/test_image_scanner.py`
|
||||
|
||||
Implement comprehensive security validation including image vulnerability scanning, Dockerfile analysis, and approval workflows.
|
||||
|
||||
#### 5.4.2 Spec Registry and Lifecycle Management
|
||||
|
||||
* `openhands/app_server/sandbox/spec_registry.py`
|
||||
* `openhands/app_server/sandbox/spec_lifecycle.py`
|
||||
* `tests/unit/app_server/sandbox/test_spec_registry.py`
|
||||
|
||||
Add persistent storage for enhanced sandbox specs, version management, and lifecycle policies (deprecation, cleanup).
|
||||
|
||||
**Demo**: Deploy multiple custom agents with different permission levels, demonstrate security validation workflows, and show proper spec lifecycle management.
|
||||
|
||||
---
|
||||
|
||||
## Key Alignment with Engineer's Approach
|
||||
|
||||
This revised implementation plan directly addresses the engineer's requirements:
|
||||
|
||||
1. **✅ Uses existing sandbox specs system** - Enhanced rather than replaced
|
||||
2. **✅ Permissions as core requirement** - Moved to M1 instead of M4
|
||||
3. **✅ Two image management approaches** - Pre-built registration and secure user uploads
|
||||
4. **✅ Security-first design** - Addresses V0 security issues with comprehensive validation
|
||||
5. **✅ Minimal infrastructure changes** - Builds on existing `SandboxSpecService` and conversation APIs
|
||||
934
doc/design-doc/custom-agent-s2.md
Normal file
934
doc/design-doc/custom-agent-s2.md
Normal file
@@ -0,0 +1,934 @@
|
||||
# Dynamic Custom Agent Package Loading (Scenario 2)
|
||||
|
||||
## 1. Introduction
|
||||
|
||||
### 1.1 Problem Statement
|
||||
|
||||
OpenHands V1 architecture uses a fixed agent server image (`ghcr.io/openhands/agent-server:5f62cee-python`) that contains the default agent implementation. Users who want to customize agent behavior with pure Python packages that don't require additional system dependencies currently have no supported mechanism to deploy their custom agents without building entirely new Docker images.
|
||||
|
||||
This creates unnecessary complexity for the common use case where users simply want to:
|
||||
- Customize agent prompts and reasoning logic
|
||||
- Add new Python-based tools and capabilities
|
||||
- Integrate with Python APIs and libraries already available in the base image
|
||||
- Deploy agents with different LLM configurations or specialized workflows
|
||||
|
||||
The current approach forces all customization through the heavyweight Scenario 1 path (custom Docker images), even when the base agent server image already contains all necessary dependencies.
|
||||
|
||||
### 1.2 Proposed Solution
|
||||
|
||||
We propose implementing **Dynamic Custom Agent Package Loading** within the existing V1 agent server container. This allows users to deploy custom agents by providing Python packages that are downloaded, installed, and instantiated at runtime without requiring custom Docker images.
|
||||
|
||||
Users will be able to:
|
||||
1. Package their custom agents as standard Python packages (pip-installable)
|
||||
2. Specify agent package URLs (Git repositories, PyPI packages, or ZIP archives) in conversation creation
|
||||
3. Have the agent server dynamically download and install the package at startup
|
||||
4. Instantiate their custom agent within the existing container environment
|
||||
5. Maintain full compatibility with the existing HTTP API (`/ask_agent` endpoint)
|
||||
|
||||
The solution leverages the existing V1 architecture's agent server container but extends the startup process to support dynamic agent loading based on environment configuration.
|
||||
|
||||
**Trade-offs**: This approach is limited to Python packages that can run within the existing agent server environment. Users needing custom system dependencies, non-Python tools, or different base images must use Scenario 1. However, this covers the majority of agent customization use cases with significantly reduced complexity.
|
||||
|
||||
## 2. User Interface
|
||||
|
||||
### 2.1 Custom Agent Package Structure
|
||||
|
||||
Users create a standard Python package with the required interface:
|
||||
|
||||
```python
|
||||
# my_custom_agent/
|
||||
├── setup.py
|
||||
├── requirements.txt # Optional additional dependencies
|
||||
├── my_custom_agent/
|
||||
│ ├── __init__.py
|
||||
│ ├── agent.py # Main agent implementation
|
||||
│ ├── tools.py # Custom tools (optional)
|
||||
│ └── config.py # Agent configuration
|
||||
```
|
||||
|
||||
### 2.2 Agent Implementation
|
||||
|
||||
```python
|
||||
# my_custom_agent/agent.py
|
||||
from openhands.sdk.agent.base import AgentBase
|
||||
from openhands.sdk.llm import LLM
|
||||
from openhands.sdk.tool import Tool
|
||||
from typing import List, Dict, Any
|
||||
|
||||
class MyCustomAgent(AgentBase):
|
||||
"""Custom agent with specialized behavior."""
|
||||
|
||||
def __init__(self, llm: LLM, tools: List[Tool], config: Dict[str, Any] = None):
|
||||
super().__init__(llm=llm, tools=tools)
|
||||
self.config = config or {}
|
||||
|
||||
async def initialize(self) -> None:
|
||||
"""Initialize custom agent resources."""
|
||||
# Custom initialization logic
|
||||
pass
|
||||
|
||||
# Factory function for agent creation
|
||||
def create_agent(llm: LLM, tools: List[Tool], config: Dict[str, Any] = None) -> AgentBase:
|
||||
"""Factory function to create the custom agent."""
|
||||
return MyCustomAgent(llm=llm, tools=tools, config=config)
|
||||
```
|
||||
|
||||
### 2.3 Package Entry Point
|
||||
|
||||
```python
|
||||
# my_custom_agent/__init__.py
|
||||
from .agent import create_agent, MyCustomAgent
|
||||
|
||||
__all__ = ['create_agent', 'MyCustomAgent']
|
||||
```
|
||||
|
||||
### 2.4 Setup Configuration
|
||||
|
||||
```python
|
||||
# setup.py
|
||||
from setuptools import setup, find_packages
|
||||
|
||||
setup(
|
||||
name="my-custom-agent",
|
||||
version="1.0.0",
|
||||
packages=find_packages(),
|
||||
install_requires=[
|
||||
# Only additional dependencies beyond base image
|
||||
"requests>=2.25.0",
|
||||
"beautifulsoup4>=4.9.0",
|
||||
],
|
||||
entry_points={
|
||||
'openhands.agents': [
|
||||
'my_custom_agent = my_custom_agent:create_agent',
|
||||
],
|
||||
},
|
||||
)
|
||||
```
|
||||
|
||||
### 2.5 Conversation Creation with Dynamic Agent Loading
|
||||
|
||||
Users create conversations by specifying the agent package URL:
|
||||
|
||||
```bash
|
||||
# Create conversation with custom agent package
|
||||
curl -X POST "https://api.openhands.ai/api/conversations" \
|
||||
-H "Authorization: Bearer $API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"agent_package_url": "git+https://github.com/user/my-custom-agent.git",
|
||||
"initial_message": "Help me analyze this codebase",
|
||||
"workspace": {
|
||||
"type": "local",
|
||||
"working_dir": "/workspace/project"
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
Alternative package sources:
|
||||
```bash
|
||||
# PyPI package
|
||||
"agent_package_url": "my-custom-agent==1.0.0"
|
||||
|
||||
# ZIP archive
|
||||
"agent_package_url": "https://example.com/agents/my-custom-agent.zip"
|
||||
|
||||
# Private Git repository
|
||||
"agent_package_url": "git+https://token@github.com/private/agent.git"
|
||||
```
|
||||
|
||||
## 3. Other Context
|
||||
|
||||
### 3.1 Current V1 Architecture Overview
|
||||
|
||||
The OpenHands V1 architecture follows a distributed service model with clear separation between the main application server and agent execution environment. Understanding this architecture is crucial for implementing dynamic agent loading.
|
||||
|
||||
#### 3.1.1 Service Separation
|
||||
|
||||
The V1 system consists of three primary components:
|
||||
|
||||
1. **Main Server** (`openhands/app_server/`): Handles user requests, conversation management, and sandbox orchestration
|
||||
2. **Agent Server** (`software-agent-sdk/openhands-agent-server/`): Executes agent logic and manages conversation state
|
||||
3. **Action Execution Server**: Handles tool execution (bash commands, file operations) within sandboxed environments
|
||||
|
||||
#### 3.1.2 Communication Flow
|
||||
|
||||
The current communication pattern follows this sequence:
|
||||
|
||||
```
|
||||
User Request → Main Server → HTTP API → Agent Server → Agent Instance → Tools → Response
|
||||
```
|
||||
|
||||
This separation allows for:
|
||||
- **Isolation**: Agent execution is isolated from the main application
|
||||
- **Scalability**: Multiple agent servers can be spawned for different conversations
|
||||
- **Security**: Sandboxed execution prevents agent actions from affecting the host system
|
||||
- **Flexibility**: Different agent configurations can be deployed without affecting the main server
|
||||
|
||||
#### 3.1.3 Container Orchestration
|
||||
|
||||
The main server uses `DockerSandboxSpecService` to create and manage agent server containers:
|
||||
|
||||
- **Image Selection**: Currently hardcoded to `ghcr.io/openhands/agent-server:5f62cee-python`
|
||||
- **Environment Configuration**: Passed via `initial_env` in `SandboxSpecInfo`
|
||||
- **Network Isolation**: Each conversation gets its own container instance
|
||||
- **Resource Management**: Memory and CPU limits enforced at container level
|
||||
|
||||
### 3.2 Agent Server Internal Architecture
|
||||
|
||||
#### 3.2.1 FastAPI Application Structure
|
||||
|
||||
The agent server is built as a FastAPI application with these key components:
|
||||
|
||||
- **Conversation Router** (`conversation_router.py`): Handles HTTP endpoints for agent interaction
|
||||
- **Conversation Service** (`conversation_service.py`): Manages conversation lifecycle and state
|
||||
- **Event Service** (`event_service.py`): Processes agent actions and observations
|
||||
- **Dependencies** (`dependencies.py`): Provides dependency injection for services
|
||||
|
||||
#### 3.2.2 Agent Instantiation Pattern
|
||||
|
||||
Currently, agents are instantiated during server startup using a fixed pattern:
|
||||
|
||||
```python
|
||||
# Simplified current pattern
|
||||
agent = Agent(
|
||||
llm=LLM(model="default-model", api_key="..."),
|
||||
tools=[TerminalTool(), FileEditorTool(), ...]
|
||||
)
|
||||
```
|
||||
|
||||
This creates a single agent instance that serves all requests to that container.
|
||||
|
||||
#### 3.2.3 Request Processing Flow
|
||||
|
||||
When the `/ask_agent` endpoint receives a request:
|
||||
|
||||
1. **Request Validation**: `AskAgentRequest` is validated and parsed
|
||||
2. **Conversation Lookup**: Conversation state is retrieved or created
|
||||
3. **Agent Invocation**: The fixed agent instance processes the question
|
||||
4. **Response Formatting**: Result is wrapped in `AskAgentResponse`
|
||||
5. **HTTP Response**: JSON response sent back to main server
|
||||
|
||||
### 3.3 Software Agent SDK Integration Points
|
||||
|
||||
#### 3.3.1 Agent Interface Requirements
|
||||
|
||||
The `software-agent-sdk` defines the contract that all agents must follow:
|
||||
|
||||
- **AgentBase**: Abstract base class requiring `llm` and `tools` parameters
|
||||
- **Tool Integration**: Agents must work with the standardized tool system
|
||||
- **Event Handling**: Agents process events through the conversation framework
|
||||
- **State Management**: Agents maintain conversation context through event streams
|
||||
|
||||
#### 3.3.2 Tool System Architecture
|
||||
|
||||
The tool system provides the foundation for agent capabilities:
|
||||
|
||||
- **Tool Registration**: Tools are registered globally and resolved by name
|
||||
- **Execution Framework**: `ToolExecutor` classes handle action execution
|
||||
- **Built-in Tools**: Standard tools (Terminal, FileEditor, Browser) are always available
|
||||
- **Custom Tools**: Additional tools can be registered through the plugin system
|
||||
|
||||
#### 3.3.3 LLM Integration
|
||||
|
||||
Agents interact with language models through the SDK's LLM abstraction:
|
||||
|
||||
- **Provider Agnostic**: Supports multiple LLM providers through unified interface
|
||||
- **Configuration**: LLM settings (model, API keys, parameters) are configurable
|
||||
- **Response Processing**: Structured handling of LLM responses and tool calls
|
||||
|
||||
### 3.4 Dynamic Loading Technical Foundation
|
||||
|
||||
#### 3.4.1 Python Package Management
|
||||
|
||||
Our dynamic loading approach leverages Python's built-in package management:
|
||||
|
||||
- **pip install**: Supports Git repositories, PyPI packages, and archive files
|
||||
- **importlib**: Enables runtime module importing and class instantiation
|
||||
- **entry_points**: Provides standardized plugin discovery mechanism
|
||||
- **sys.path**: Allows dynamic modification of Python module search paths
|
||||
|
||||
#### 3.4.2 Container Environment Considerations
|
||||
|
||||
The agent server container provides a controlled environment for dynamic loading:
|
||||
|
||||
- **Python Runtime**: Pre-installed Python 3.x with pip and common libraries
|
||||
- **Network Access**: Required for downloading packages from external sources
|
||||
- **File System**: Writable areas for package installation and caching
|
||||
- **Security Context**: Isolated from host system with appropriate permissions
|
||||
|
||||
#### 3.4.3 State Management Implications
|
||||
|
||||
Dynamic agent loading affects conversation state management:
|
||||
|
||||
- **Agent Persistence**: Custom agents must maintain state across requests
|
||||
- **Configuration Isolation**: Different conversations can use different agent configurations
|
||||
- **Resource Cleanup**: Proper cleanup of agent resources when conversations end
|
||||
- **Error Recovery**: Fallback mechanisms when custom agents fail to load or execute
|
||||
|
||||
## 4. Technical Design
|
||||
|
||||
### 4.1 Current V1 Agent Instantiation Flow
|
||||
|
||||
To understand how our proposal integrates with the existing system, it's important to first examine how agents are currently instantiated and executed in the V1 architecture.
|
||||
|
||||
#### 4.1.1 Current Agent Server Startup Process
|
||||
|
||||
In the current V1 flow, agent instantiation follows this sequence:
|
||||
|
||||
1. **Main Server Request**: When a user creates a conversation, the main server (`openhands/app_server`) creates a sandbox specification via `DockerSandboxSpecService.get_default_sandbox_specs()`
|
||||
2. **Container Launch**: The sandbox service launches the agent server container using the hardcoded image `ghcr.io/openhands/agent-server:5f62cee-python`
|
||||
3. **Agent Server Initialization**: The agent server container starts with the command `['--port', '8000']` and initializes a FastAPI application
|
||||
4. **Default Agent Creation**: During startup, the agent server creates a default agent instance (typically from the software-agent-sdk) with standard tools and configuration
|
||||
5. **HTTP API Ready**: The agent server exposes the `/api/conversations/{id}/ask_agent` endpoint, routing requests to the default agent instance
|
||||
|
||||
#### 4.1.2 Current Agent Execution Flow
|
||||
|
||||
When a user sends a message through the V1 API:
|
||||
|
||||
1. **HTTP Request**: Main server makes POST request to `http://agent-server:8000/api/conversations/{id}/ask_agent`
|
||||
2. **Agent Router**: `conversation_router.py` receives the request and extracts the `AskAgentRequest`
|
||||
3. **Conversation Service**: `ConversationService.ask_agent()` method is called with the user's question
|
||||
4. **Event Service**: The request is forwarded to `EventService.ask_agent()` which manages the conversation state
|
||||
5. **Agent Execution**: The default agent processes the question using its configured LLM and tools
|
||||
6. **Response Return**: The agent's response is returned through the same HTTP chain back to the main server
|
||||
|
||||
#### 4.1.3 Limitations of Current Approach
|
||||
|
||||
The current system has several limitations for custom agent deployment:
|
||||
|
||||
- **Fixed Agent Implementation**: The agent server container contains a single, hardcoded agent implementation
|
||||
- **Static Configuration**: Agent behavior cannot be modified without rebuilding the entire container
|
||||
- **No Runtime Customization**: Users cannot specify different agent types or configurations per conversation
|
||||
- **Deployment Complexity**: Any agent customization requires building and maintaining custom Docker images
|
||||
|
||||
### 4.2 Proposed Dynamic Agent Loading Architecture
|
||||
|
||||
Our proposal extends the current V1 flow by introducing dynamic agent loading capabilities while maintaining full backward compatibility with existing APIs and infrastructure.
|
||||
|
||||
#### 4.2.1 Enhanced Agent Server Startup Process
|
||||
|
||||
The modified startup process introduces agent selection based on environment configuration:
|
||||
|
||||
1. **Environment Detection**: During agent server startup, check for `CUSTOM_AGENT_PACKAGE_URL` environment variable
|
||||
2. **Conditional Loading**: If custom agent URL is present, download and install the package; otherwise use default agent
|
||||
3. **Agent Factory Creation**: Create an agent factory function that can instantiate either custom or default agents
|
||||
4. **HTTP API Registration**: Register the same `/ask_agent` endpoint, but route to the dynamically selected agent
|
||||
|
||||
#### 4.2.2 Dynamic Package Installation Process
|
||||
|
||||
When a custom agent package URL is detected, the system performs these steps:
|
||||
|
||||
1. **Package Download**: Use `pip install` to download the package from Git, PyPI, or ZIP sources
|
||||
2. **Dependency Resolution**: Install any additional Python dependencies specified in the package
|
||||
3. **Module Import**: Use `importlib` to dynamically import the custom agent module
|
||||
4. **Agent Instantiation**: Call the package's `create_agent()` factory function with LLM and tools
|
||||
5. **Initialization**: Execute any custom initialization logic defined by the agent
|
||||
6. **Caching**: Cache the agent instance for reuse across multiple requests
|
||||
|
||||
#### 4.2.3 Modified Execution Flow
|
||||
|
||||
The execution flow remains largely unchanged from the user's perspective, but internally:
|
||||
|
||||
1. **Same HTTP API**: The `/ask_agent` endpoint signature and behavior remain identical
|
||||
2. **Dynamic Routing**: Requests are routed to either custom or default agent based on startup configuration
|
||||
3. **Transparent Operation**: The main server is unaware of whether it's communicating with a custom or default agent
|
||||
4. **Consistent Response Format**: All agents return responses in the same `AskAgentResponse` format
|
||||
|
||||
### 4.3 Integration Points and Modifications
|
||||
|
||||
#### 4.3.1 Sandbox Service Modifications
|
||||
|
||||
The main server's sandbox service requires minimal changes to support dynamic agent loading:
|
||||
|
||||
```python
|
||||
# Current: Fixed environment for all conversations
|
||||
def get_default_sandbox_specs():
|
||||
return [SandboxSpecInfo(
|
||||
id=AGENT_SERVER_IMAGE,
|
||||
command=['--port', '8000'],
|
||||
initial_env={...} # Standard environment
|
||||
)]
|
||||
|
||||
# Enhanced: Dynamic environment based on conversation requirements
|
||||
def create_dynamic_agent_sandbox_spec(agent_package_url: str):
|
||||
return SandboxSpecInfo(
|
||||
id=AGENT_SERVER_IMAGE, # Same base image
|
||||
command=['--port', '8000'],
|
||||
initial_env={
|
||||
...standard_env,
|
||||
'CUSTOM_AGENT_PACKAGE_URL': agent_package_url # New variable
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
#### 4.3.2 Agent Server Startup Modifications
|
||||
|
||||
The agent server startup process is enhanced to detect and load custom agents:
|
||||
|
||||
```python
|
||||
# Current: Fixed agent creation
|
||||
@app.on_event("startup")
|
||||
async def startup_event():
|
||||
app.state.agent = DefaultAgent(llm=default_llm, tools=default_tools)
|
||||
|
||||
# Enhanced: Dynamic agent creation
|
||||
@app.on_event("startup")
|
||||
async def startup_event():
|
||||
custom_agent_url = os.getenv('CUSTOM_AGENT_PACKAGE_URL')
|
||||
if custom_agent_url:
|
||||
loader = DynamicAgentLoader()
|
||||
app.state.agent = await loader.load_agent_from_url(custom_agent_url, ...)
|
||||
else:
|
||||
app.state.agent = DefaultAgent(llm=default_llm, tools=default_tools)
|
||||
```
|
||||
|
||||
#### 4.3.3 Conversation Service Integration
|
||||
|
||||
The conversation service routing logic is updated to use the dynamically loaded agent:
|
||||
|
||||
```python
|
||||
# Current: Direct agent usage
|
||||
async def ask_agent(self, conversation_id: UUID, question: str) -> str:
|
||||
event_service = self.event_services[conversation_id]
|
||||
return await event_service.ask_agent(question)
|
||||
|
||||
# Enhanced: Dynamic agent resolution
|
||||
async def ask_agent(self, conversation_id: UUID, question: str) -> str:
|
||||
event_service = self.event_services[conversation_id]
|
||||
# Agent is now dynamically determined at startup
|
||||
return await event_service.ask_agent(question)
|
||||
```
|
||||
|
||||
### 4.4 Dynamic Agent Loading Implementation
|
||||
|
||||
#### 4.4.1 Agent Package Loader
|
||||
|
||||
```python
|
||||
# openhands/agent_server/dynamic_agent_loader.py
|
||||
import subprocess
|
||||
import importlib
|
||||
import tempfile
|
||||
import os
|
||||
import sys
|
||||
from typing import Dict, Any, Optional
|
||||
from urllib.parse import urlparse
|
||||
from pathlib import Path
|
||||
|
||||
from openhands.sdk.agent.base import AgentBase
|
||||
from openhands.sdk.llm import LLM
|
||||
from openhands.sdk.tool import Tool
|
||||
from openhands.sdk.logger import get_logger
|
||||
|
||||
logger = get_logger(__name__)
|
||||
|
||||
class DynamicAgentLoader:
|
||||
"""Loads custom agents from package URLs at runtime."""
|
||||
|
||||
def __init__(self):
|
||||
self.installed_packages: Dict[str, str] = {}
|
||||
|
||||
async def load_agent_from_url(
|
||||
self,
|
||||
package_url: str,
|
||||
llm: LLM,
|
||||
tools: list[Tool],
|
||||
config: Optional[Dict[str, Any]] = None
|
||||
) -> AgentBase:
|
||||
"""Load and instantiate agent from package URL."""
|
||||
|
||||
# Check if already installed
|
||||
if package_url in self.installed_packages:
|
||||
package_name = self.installed_packages[package_url]
|
||||
return await self._create_agent_instance(package_name, llm, tools, config)
|
||||
|
||||
# Install the package
|
||||
package_name = await self._install_package(package_url)
|
||||
self.installed_packages[package_url] = package_name
|
||||
|
||||
# Create agent instance
|
||||
return await self._create_agent_instance(package_name, llm, tools, config)
|
||||
|
||||
async def _install_package(self, package_url: str) -> str:
|
||||
"""Install package from URL and return package name."""
|
||||
|
||||
logger.info(f"Installing custom agent package: {package_url}")
|
||||
|
||||
try:
|
||||
# Install package using pip
|
||||
result = subprocess.run([
|
||||
sys.executable, "-m", "pip", "install", package_url
|
||||
], capture_output=True, text=True, check=True)
|
||||
|
||||
logger.info(f"Package installation successful: {result.stdout}")
|
||||
|
||||
# Extract package name from URL
|
||||
package_name = self._extract_package_name(package_url)
|
||||
return package_name
|
||||
|
||||
except subprocess.CalledProcessError as e:
|
||||
logger.error(f"Failed to install package {package_url}: {e.stderr}")
|
||||
raise RuntimeError(f"Package installation failed: {e.stderr}")
|
||||
|
||||
def _extract_package_name(self, package_url: str) -> str:
|
||||
"""Extract package name from various URL formats."""
|
||||
|
||||
if package_url.startswith('git+'):
|
||||
# Git URL: extract repo name
|
||||
url = package_url.replace('git+', '')
|
||||
return Path(urlparse(url).path).stem
|
||||
elif '==' in package_url:
|
||||
# PyPI with version: extract package name
|
||||
return package_url.split('==')[0]
|
||||
elif package_url.endswith('.zip'):
|
||||
# ZIP file: extract filename
|
||||
return Path(urlparse(package_url).path).stem
|
||||
else:
|
||||
# Assume it's a simple package name
|
||||
return package_url
|
||||
|
||||
async def _create_agent_instance(
|
||||
self,
|
||||
package_name: str,
|
||||
llm: LLM,
|
||||
tools: list[Tool],
|
||||
config: Optional[Dict[str, Any]] = None
|
||||
) -> AgentBase:
|
||||
"""Create agent instance from installed package."""
|
||||
|
||||
try:
|
||||
# Import the package
|
||||
module = importlib.import_module(package_name)
|
||||
|
||||
# Look for create_agent function
|
||||
if hasattr(module, 'create_agent'):
|
||||
create_agent_func = getattr(module, 'create_agent')
|
||||
agent = create_agent_func(llm=llm, tools=tools, config=config)
|
||||
else:
|
||||
# Fallback: look for agent class
|
||||
agent_classes = [
|
||||
attr for attr in dir(module)
|
||||
if (isinstance(getattr(module, attr), type) and
|
||||
issubclass(getattr(module, attr), AgentBase) and
|
||||
getattr(module, attr) != AgentBase)
|
||||
]
|
||||
|
||||
if not agent_classes:
|
||||
raise RuntimeError(f"No agent class found in package {package_name}")
|
||||
|
||||
agent_class = getattr(module, agent_classes[0])
|
||||
agent = agent_class(llm=llm, tools=tools, config=config)
|
||||
|
||||
# Initialize the agent
|
||||
if hasattr(agent, 'initialize'):
|
||||
await agent.initialize()
|
||||
|
||||
logger.info(f"Successfully created agent from package: {package_name}")
|
||||
return agent
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to create agent from package {package_name}: {e}")
|
||||
raise RuntimeError(f"Agent instantiation failed: {e}")
|
||||
```
|
||||
|
||||
#### 4.1.2 Agent Server Integration
|
||||
|
||||
```python
|
||||
# Modified openhands/agent_server/conversation_service.py
|
||||
import os
|
||||
from typing import Optional
|
||||
from openhands.agent_server.dynamic_agent_loader import DynamicAgentLoader
|
||||
from openhands.sdk.agent.base import AgentBase
|
||||
from openhands.sdk.agent import Agent # Default agent
|
||||
|
||||
class ConversationService:
|
||||
"""Enhanced conversation service with dynamic agent loading."""
|
||||
|
||||
def __init__(self, config: Config):
|
||||
self.config = config
|
||||
self.agent_loader = DynamicAgentLoader()
|
||||
self._default_agent_factory = None
|
||||
self._custom_agent_cache: Dict[str, AgentBase] = {}
|
||||
|
||||
async def _get_or_create_agent(
|
||||
self,
|
||||
conversation_id: UUID,
|
||||
llm: LLM,
|
||||
tools: list[Tool]
|
||||
) -> AgentBase:
|
||||
"""Get or create agent for conversation."""
|
||||
|
||||
# Check for custom agent package URL in environment
|
||||
custom_agent_url = os.getenv('CUSTOM_AGENT_PACKAGE_URL')
|
||||
|
||||
if custom_agent_url:
|
||||
# Use custom agent
|
||||
if custom_agent_url not in self._custom_agent_cache:
|
||||
agent = await self.agent_loader.load_agent_from_url(
|
||||
package_url=custom_agent_url,
|
||||
llm=llm,
|
||||
tools=tools,
|
||||
config=self._get_agent_config()
|
||||
)
|
||||
self._custom_agent_cache[custom_agent_url] = agent
|
||||
|
||||
return self._custom_agent_cache[custom_agent_url]
|
||||
else:
|
||||
# Use default agent
|
||||
if not self._default_agent_factory:
|
||||
self._default_agent_factory = Agent(llm=llm, tools=tools)
|
||||
|
||||
return self._default_agent_factory
|
||||
|
||||
def _get_agent_config(self) -> Dict[str, Any]:
|
||||
"""Extract agent configuration from environment."""
|
||||
config = {}
|
||||
|
||||
# Parse JSON config if provided
|
||||
config_json = os.getenv('CUSTOM_AGENT_CONFIG')
|
||||
if config_json:
|
||||
import json
|
||||
config.update(json.loads(config_json))
|
||||
|
||||
return config
|
||||
```
|
||||
|
||||
### 4.2 Sandbox Service Integration
|
||||
|
||||
#### 4.2.1 Enhanced Sandbox Specification
|
||||
|
||||
```python
|
||||
# openhands/app_server/sandbox/docker_sandbox_spec_service.py
|
||||
from typing import Optional
|
||||
|
||||
class DockerSandboxSpecService(SandboxSpecService):
|
||||
"""Enhanced sandbox service supporting dynamic agent loading."""
|
||||
|
||||
def create_dynamic_agent_sandbox_spec(
|
||||
self,
|
||||
agent_package_url: str,
|
||||
agent_config: Optional[Dict[str, Any]] = None
|
||||
) -> SandboxSpecInfo:
|
||||
"""Create sandbox spec with dynamic agent loading configuration."""
|
||||
|
||||
# Base environment from existing implementation
|
||||
base_env = {
|
||||
'OPENVSCODE_SERVER_ROOT': '/openhands/.openvscode-server',
|
||||
'OH_ENABLE_VNC': '0',
|
||||
'LOG_JSON': 'true',
|
||||
'OH_CONVERSATIONS_PATH': '/workspace/conversations',
|
||||
'OH_BASH_EVENTS_DIR': '/workspace/bash_events',
|
||||
'PYTHONUNBUFFERED': '1',
|
||||
'ENV_LOG_LEVEL': '20',
|
||||
}
|
||||
|
||||
# Add dynamic agent configuration
|
||||
dynamic_env = {
|
||||
**base_env,
|
||||
'CUSTOM_AGENT_PACKAGE_URL': agent_package_url,
|
||||
}
|
||||
|
||||
# Add agent configuration as JSON if provided
|
||||
if agent_config:
|
||||
import json
|
||||
dynamic_env['CUSTOM_AGENT_CONFIG'] = json.dumps(agent_config)
|
||||
|
||||
return SandboxSpecInfo(
|
||||
id=AGENT_SERVER_IMAGE, # Same base image
|
||||
command=['--port', '8000'],
|
||||
initial_env=dynamic_env,
|
||||
working_dir='/workspace/project',
|
||||
)
|
||||
```
|
||||
|
||||
#### 4.2.2 Conversation Creation API Enhancement
|
||||
|
||||
```python
|
||||
# openhands/server/routes/conversation_routes.py
|
||||
from pydantic import BaseModel
|
||||
from typing import Optional, Dict, Any
|
||||
|
||||
class CreateConversationRequest(BaseModel):
|
||||
"""Enhanced conversation creation request."""
|
||||
initial_message: str
|
||||
workspace_config: Optional[Dict[str, Any]] = None
|
||||
# New field for dynamic agent loading
|
||||
agent_package_url: Optional[str] = None
|
||||
agent_config: Optional[Dict[str, Any]] = None
|
||||
|
||||
@router.post("/conversations")
|
||||
async def create_conversation(
|
||||
request: CreateConversationRequest,
|
||||
sandbox_service: DockerSandboxSpecService = Depends(get_sandbox_service)
|
||||
) -> ConversationResponse:
|
||||
"""Create conversation with optional dynamic agent loading."""
|
||||
|
||||
if request.agent_package_url:
|
||||
# Create sandbox with dynamic agent loading
|
||||
sandbox_spec = sandbox_service.create_dynamic_agent_sandbox_spec(
|
||||
agent_package_url=request.agent_package_url,
|
||||
agent_config=request.agent_config
|
||||
)
|
||||
else:
|
||||
# Use default sandbox specification
|
||||
sandbox_spec = sandbox_service.get_default_sandbox_specs()[0]
|
||||
|
||||
# Create sandbox and conversation
|
||||
sandbox = await sandbox_service.create_sandbox(sandbox_spec)
|
||||
await wait_for_agent_server_ready(sandbox)
|
||||
|
||||
conversation = await create_conversation_with_sandbox(
|
||||
sandbox=sandbox,
|
||||
initial_message=request.initial_message,
|
||||
workspace_config=request.workspace_config
|
||||
)
|
||||
|
||||
return ConversationResponse(
|
||||
conversation_id=conversation.id,
|
||||
status="created",
|
||||
agent_type="custom" if request.agent_package_url else "default"
|
||||
)
|
||||
```
|
||||
|
||||
### 4.3 Agent Server Startup Process
|
||||
|
||||
#### 4.3.1 Enhanced Agent Server Initialization
|
||||
|
||||
```python
|
||||
# openhands/agent_server/api.py startup modification
|
||||
import os
|
||||
from openhands.agent_server.dynamic_agent_loader import DynamicAgentLoader
|
||||
|
||||
@app.on_event("startup")
|
||||
async def startup_event():
|
||||
"""Enhanced startup with dynamic agent loading support."""
|
||||
|
||||
# Initialize dynamic agent loader
|
||||
app.state.agent_loader = DynamicAgentLoader()
|
||||
|
||||
# Check for custom agent package URL
|
||||
custom_agent_url = os.getenv('CUSTOM_AGENT_PACKAGE_URL')
|
||||
|
||||
if custom_agent_url:
|
||||
logger.info(f"Dynamic agent loading enabled: {custom_agent_url}")
|
||||
# Pre-validate package URL (optional)
|
||||
try:
|
||||
await app.state.agent_loader._install_package(custom_agent_url)
|
||||
logger.info("Custom agent package pre-installed successfully")
|
||||
except Exception as e:
|
||||
logger.warning(f"Custom agent pre-installation failed: {e}")
|
||||
# Continue with startup - will retry on first conversation
|
||||
else:
|
||||
logger.info("Using default agent configuration")
|
||||
```
|
||||
|
||||
### 4.4 Error Handling and Fallback
|
||||
|
||||
#### 4.4.1 Robust Error Handling
|
||||
|
||||
```python
|
||||
# openhands/agent_server/dynamic_agent_loader.py (enhanced)
|
||||
class DynamicAgentLoader:
|
||||
"""Enhanced loader with comprehensive error handling."""
|
||||
|
||||
async def load_agent_with_fallback(
|
||||
self,
|
||||
package_url: str,
|
||||
llm: LLM,
|
||||
tools: list[Tool],
|
||||
config: Optional[Dict[str, Any]] = None
|
||||
) -> AgentBase:
|
||||
"""Load custom agent with fallback to default agent."""
|
||||
|
||||
try:
|
||||
return await self.load_agent_from_url(package_url, llm, tools, config)
|
||||
except Exception as e:
|
||||
logger.error(f"Custom agent loading failed: {e}")
|
||||
logger.info("Falling back to default agent")
|
||||
|
||||
# Import default agent
|
||||
from openhands.sdk.agent import Agent
|
||||
return Agent(llm=llm, tools=tools)
|
||||
|
||||
async def _validate_package_url(self, package_url: str) -> bool:
|
||||
"""Validate package URL accessibility."""
|
||||
|
||||
try:
|
||||
if package_url.startswith('git+'):
|
||||
# Validate Git repository access
|
||||
import subprocess
|
||||
result = subprocess.run([
|
||||
'git', 'ls-remote', package_url.replace('git+', '')
|
||||
], capture_output=True, timeout=30)
|
||||
return result.returncode == 0
|
||||
elif package_url.startswith('http'):
|
||||
# Validate HTTP URL accessibility
|
||||
import httpx
|
||||
async with httpx.AsyncClient() as client:
|
||||
response = await client.head(package_url, timeout=30)
|
||||
return response.status_code == 200
|
||||
else:
|
||||
# Assume PyPI package - always return True
|
||||
return True
|
||||
except Exception:
|
||||
return False
|
||||
```
|
||||
|
||||
### 4.5 Security and Isolation
|
||||
|
||||
#### 4.5.1 Package Security Validation
|
||||
|
||||
```python
|
||||
# openhands/agent_server/security/package_validator.py
|
||||
import re
|
||||
from typing import List, Set
|
||||
from urllib.parse import urlparse
|
||||
|
||||
class PackageSecurityValidator:
|
||||
"""Validates custom agent packages for security compliance."""
|
||||
|
||||
ALLOWED_DOMAINS: Set[str] = {
|
||||
'github.com',
|
||||
'gitlab.com',
|
||||
'bitbucket.org',
|
||||
'pypi.org',
|
||||
'files.pythonhosted.org'
|
||||
}
|
||||
|
||||
BLOCKED_PACKAGES: Set[str] = {
|
||||
# Add known malicious packages
|
||||
}
|
||||
|
||||
def validate_package_url(self, package_url: str) -> bool:
|
||||
"""Validate package URL against security policies."""
|
||||
|
||||
# Check blocked packages
|
||||
if self._is_blocked_package(package_url):
|
||||
return False
|
||||
|
||||
# Validate domain for HTTP/Git URLs
|
||||
if package_url.startswith(('http', 'git+')):
|
||||
parsed = urlparse(package_url.replace('git+', ''))
|
||||
if parsed.hostname not in self.ALLOWED_DOMAINS:
|
||||
return False
|
||||
|
||||
# Additional security checks
|
||||
return self._validate_package_name(package_url)
|
||||
|
||||
def _is_blocked_package(self, package_url: str) -> bool:
|
||||
"""Check if package is in blocklist."""
|
||||
for blocked in self.BLOCKED_PACKAGES:
|
||||
if blocked in package_url.lower():
|
||||
return True
|
||||
return False
|
||||
|
||||
def _validate_package_name(self, package_url: str) -> bool:
|
||||
"""Validate package name format."""
|
||||
# Basic validation for malicious patterns
|
||||
malicious_patterns = [
|
||||
r'\.\./', # Path traversal
|
||||
r'[;&|`$]', # Command injection
|
||||
r'<script', # XSS attempts
|
||||
]
|
||||
|
||||
for pattern in malicious_patterns:
|
||||
if re.search(pattern, package_url, re.IGNORECASE):
|
||||
return False
|
||||
|
||||
return True
|
||||
```
|
||||
|
||||
## 5. Implementation Plan
|
||||
|
||||
All implementation must pass existing lints and tests. New functionality requires comprehensive test coverage including unit tests, integration tests, and end-to-end scenarios.
|
||||
|
||||
### 5.1 Dynamic Agent Loading Foundation (M1)
|
||||
|
||||
#### 5.1.1 Dynamic Agent Loader Implementation
|
||||
|
||||
* `openhands/agent_server/dynamic_agent_loader.py`
|
||||
* `tests/unit/agent_server/test_dynamic_agent_loader.py`
|
||||
|
||||
Implement core dynamic agent loading functionality with package installation, module importing, and agent instantiation.
|
||||
|
||||
#### 5.1.2 Package Security Validation
|
||||
|
||||
* `openhands/agent_server/security/package_validator.py`
|
||||
* `tests/unit/agent_server/security/test_package_validator.py`
|
||||
|
||||
Add security validation for custom agent packages including domain allowlists and malicious pattern detection.
|
||||
|
||||
**Demo**: Load a simple custom agent from a Git repository and verify it responds to basic queries through the existing `/ask_agent` HTTP API.
|
||||
|
||||
### 5.2 Sandbox Service Integration (M2)
|
||||
|
||||
#### 5.2.1 Enhanced Sandbox Specification
|
||||
|
||||
* `openhands/app_server/sandbox/docker_sandbox_spec_service.py` (modifications)
|
||||
* `tests/unit/app_server/sandbox/test_docker_sandbox_spec_service.py` (enhancements)
|
||||
|
||||
Extend existing sandbox service to support dynamic agent loading configuration through environment variables.
|
||||
|
||||
#### 5.2.2 Agent Server Startup Integration
|
||||
|
||||
* `openhands/agent_server/conversation_service.py` (modifications)
|
||||
* `openhands/agent_server/api.py` (startup enhancements)
|
||||
* `tests/unit/agent_server/test_conversation_service.py` (enhancements)
|
||||
|
||||
Integrate dynamic agent loading into agent server startup and conversation management processes.
|
||||
|
||||
**Demo**: Create conversations with custom agents specified via environment variables and demonstrate proper agent instantiation and tool execution.
|
||||
|
||||
### 5.3 API Integration (M3)
|
||||
|
||||
#### 5.3.1 Enhanced Conversation Creation API
|
||||
|
||||
* `openhands/server/routes/conversation_routes.py` (modifications)
|
||||
* `tests/unit/server/routes/test_conversation_routes.py` (enhancements)
|
||||
|
||||
Extend conversation creation API to accept agent package URLs and configuration parameters.
|
||||
|
||||
#### 5.3.2 Error Handling and Fallback
|
||||
|
||||
* `openhands/agent_server/dynamic_agent_loader.py` (enhancements)
|
||||
* `tests/unit/agent_server/test_dynamic_agent_fallback.py`
|
||||
|
||||
Implement comprehensive error handling with fallback to default agents when custom agent loading fails.
|
||||
|
||||
**Demo**: Create conversations through API endpoints with various package URL formats (Git, PyPI, ZIP) and demonstrate proper error handling and fallback behavior.
|
||||
|
||||
### 5.4 Advanced Features and Optimization (M4)
|
||||
|
||||
#### 5.4.1 Agent Caching and Performance
|
||||
|
||||
* `openhands/agent_server/agent_cache.py`
|
||||
* `tests/unit/agent_server/test_agent_cache.py`
|
||||
|
||||
Implement agent instance caching to avoid repeated package installation and improve performance for multiple conversations with the same custom agent.
|
||||
|
||||
#### 5.4.2 Package Management and Cleanup
|
||||
|
||||
* `openhands/agent_server/package_manager.py`
|
||||
* `tests/unit/agent_server/test_package_manager.py`
|
||||
|
||||
Add package lifecycle management including cleanup of unused packages and version management for package updates.
|
||||
|
||||
**Demo**: Deploy multiple conversations with different custom agents simultaneously and demonstrate proper resource management, caching, and cleanup behavior.
|
||||
|
||||
---
|
||||
|
||||
## References
|
||||
|
||||
This design document is based on analysis of the following source materials:
|
||||
|
||||
1. **OpenHands V1 Architecture**: Analysis of `openhands/app_server/sandbox/docker_sandbox_spec_service.py` and `openhands/app_server/event_callback/github_v1_callback_processor.py` for understanding the V1 flow and agent server integration.
|
||||
|
||||
2. **Software Agent SDK**: Analysis of the `software-agent-sdk` repository, specifically:
|
||||
- `openhands-agent-server/openhands/agent_server/conversation_router.py` for HTTP API patterns
|
||||
- `openhands-sdk/openhands/sdk/agent/base.py` for agent interface requirements
|
||||
- `examples/01_standalone_sdk/02_custom_tools.py` for custom agent implementation patterns
|
||||
|
||||
3. **Agent Server Models**: Analysis of `openhands.agent_server.models` imports in the main OpenHands codebase for understanding the API contract between main server and agent server.
|
||||
|
||||
4. **Container Architecture**: Analysis of `AGENT_SERVER_IMAGE` constant usage in `openhands/app_server/sandbox/sandbox_spec_service.py` for understanding the current container deployment model.
|
||||
|
||||
All technical specifications and implementation details are derived from examination of the existing codebase and established patterns within the OpenHands ecosystem.
|
||||
Reference in New Issue
Block a user