mini-openclaw-langchain: Instructions file for Codex

AGENTS.md

Guidance for coding agents that modify this repository.

Project overview

Mini-OpenClaw is a local-first multi-agent workspace with:

• a FastAPI backend in backend/
• a Next.js frontend in frontend/
• a repo-local CLI in ./oml and ./oml.ps1
• per-agent workspaces under backend/workspaces/<agent_id>/

The backend owns runtime config, tool policy, scheduler behavior, template loading, and persistence. The frontend owns the operator UI and API client behavior.

Repository map

• backend/app.py: FastAPI entrypoint, middleware, health/readiness, optional frontend proxy
• backend/config.py: runtime schema, config parsing, LLM profile/default loading
• backend/config.json: canonical repo-level runtime and provider config
• backend/agent_templates/: shipped template presets
• backend/tests/backend/: backend unit and API coverage
• frontend/src/app/: Next.js routes
• frontend/src/lib/api.ts: typed frontend API wrappers
• frontend/src/components/: UI components
• docker-compose.yml: Docker entrypoint for prod and dev profiles
• docker/nginx/default.conf: public edge routing for the production-like Docker profile

Core commands

Local

./oml start
./oml stop
./oml status

Backend

cd backend
./.venv/bin/pytest -q

Frontend

cd frontend
npm run test:run
npm run build

Docker

cp .env.example .env
docker compose --profile prod up --build -d
docker compose --profile dev up --build -d

# Stop the containers.
# Do NOT add "-v" unless explicitly removing volumes and reset all persisted data by user's prompt.
docker compose --profile prod down
docker compose --profile dev down

Change boundaries

• Do not treat root AGENTS.md as a runtime prompt file. It is contributor guidance only.
• Do not confuse root docs with generated workspace files under backend/workspaces/.../workspace/.
• Keep backend/config.json as the source of truth for repo-level runtime defaults and provider configuration.
• Keep agent templates limited to runtime_config patches. Do not place secrets, llm_profiles, llm_defaults, or agent_llm_overrides in template files.
• Preserve current ./oml local workflows when adding Docker or docs changes.