| name | lobster-dev |
| description | Develop, extend, and contribute to Lobster AI — the multi-agent bioinformatics engine.
Use when working on Lobster codebase, creating agents/services, understanding architecture,
fixing bugs, adding features, or contributing to the open-source project.
Trigger phrases: "add agent", "create service", "extend lobster", "contribute",
"understand architecture", "how does X work in lobster", "fix bug", "add feature",
"write tests", "lobster development", "agent development", "bioinformatics code"
|
Lobster AI Development Guide
Lobster AI is a multi-agent bioinformatics platform using LangGraph for orchestration.
This skill teaches you how to work with, extend, and contribute to the codebase.
Quick Navigation
Critical Rules
- ComponentRegistry is truth — Agents discovered via entry points, NOT hardcoded
- AGENT_CONFIG at module top — Define before heavy imports for <50ms discovery
- Services return 3-tuple —
(AnnData, Dict, AnalysisStep) always
- Always pass
ir — log_tool_usage(..., ir=ir) for reproducibility
- No
lobster/__init__.py — PEP 420 namespace package
Package Structure
lobster/
├── packages/ # Agent packages (PEP 420)
│ ├── lobster-transcriptomics/ # transcriptomics_expert, annotation_expert, de_analysis_expert
│ ├── lobster-research/ # research_agent, data_expert_agent
│ ├── lobster-visualization/ # visualization_expert
│ ├── lobster-metadata/ # metadata_assistant
│ ├── lobster-structural-viz/ # protein_structure_visualization_expert
│ ├── lobster-genomics/ # genomics_expert
│ ├── lobster-proteomics/ # proteomics_expert
│ └── lobster-ml/ # machine_learning_expert
└── lobster/ # Core SDK
├── agents/supervisor.py # Supervisor (stays in core)
├── agents/graph.py # LangGraph builder
├── core/ # Infrastructure (registry, data_manager, provenance)
├── services/ # Analysis services
└── tools/ # Agent tools
Quick Commands
make dev-install
make test
make format
uv tool install 'lobster-ai[full,anthropic]'
uv tool upgrade lobster-ai
lobster chat
lobster query "your request"
pytest tests/unit/
pytest tests/integration/
Service Pattern (Essential)
All services return a 3-tuple:
def analyze(self, adata, **params) -> Tuple[AnnData, Dict, AnalysisStep]:
stats = {"n_cells": adata.n_obs, "status": "complete"}
ir = AnalysisStep(
activity_type="analyze",
inputs={"n_obs": adata.n_obs},
outputs=stats,
params=params
)
return processed_adata, stats, ir
Tools wrap services:
@tool
def analyze_modality(modality_name: str, **params) -> str:
result, stats, ir = service.analyze(adata, **params)
data_manager.log_tool_usage("analyze", params, stats, ir=ir)
return f"Complete: {stats}"
Agent Registration (Entry Points)
Agents register via pyproject.toml:
[project.entry-points."lobster.agents"]
my_agent = "lobster.agents.my_domain.my_agent:AGENT_CONFIG"
AGENT_CONFIG must be defined at module top (before imports):
from lobster.config.agent_registry import AgentRegistryConfig
AGENT_CONFIG = AgentRegistryConfig(
name="my_agent",
display_name="My Expert Agent",
description="What this agent does",
factory_function="lobster.agents.mydomain.my_agent.my_agent",
handoff_tool_name="handoff_to_my_agent",
handoff_tool_description="Assign tasks for my domain analysis",
tier_requirement="free",
)
from lobster.core.data_manager_v2 import DataManagerV2
Key Files
| File | Purpose |
|---|
lobster/agents/graph.py | LangGraph orchestration |
lobster/core/component_registry.py | Agent discovery |
lobster/core/data_manager_v2.py | Data/workspace management |
lobster/core/provenance.py | W3C-PROV tracking |
lobster/cli.py | CLI implementation |
Online Documentation
Full documentation at docs.omics-os.com (or local docs-site/):
- Getting Started:
docs/getting-started/
- Core SDK:
docs/core/
- Agents:
docs/agents/
- Developer Guide:
docs/developer/
- API Reference:
docs/api-reference/
Common Tasks
Adding a New Agent
- Create package:
packages/lobster-mydomain/
- Define AGENT_CONFIG at top of agent file
- Register entry point in
pyproject.toml
- Implement agent with tools
- Add tests in
tests/unit/agents/
See references/creating-agents.md for full guide.
Adding a New Service
- Create service class in appropriate package
- Implement 3-tuple return pattern
- Wrap in tool with
log_tool_usage
- Add unit tests
See references/creating-services.md for full guide.
Understanding Data Flow
User Query → CLI → LobsterClientAdapter → AgentClient
↓
LangGraph (supervisor → agents)
↓
Services → DataManagerV2
↓
Results + Provenance
Testing
pytest tests/unit/ -v
pytest tests/integration/ -v
pytest tests/unit/test_my_feature.py -v
pytest --cov=lobster tests/
Contributing
- Fork the repository
- Create feature branch:
git checkout -b feature/my-feature
- Make changes following patterns above
- Run tests:
make test
- Format code:
make format
- Submit PR with clear description