Tolokaforge - LLM Tool-Use Benchmarking Harness
Project description
Tolokaforge
A benchmarking harness for evaluating tool-using LLM agents. Multi-turn agent/user loops, sandboxed execution, deterministic grading, and rich telemetry — across any provider via LiteLLM.
Highlights
- Agent + User Loop – Multi-turn conversations where both agent and user models call tools.
- Sandboxed Execution – Tool calls proxy into Dockerized services with no external network access.
- MCP-Compatible Tooling – Tasks declare tools via Model Context Protocol or built-ins.
- Deterministic Grading – JSONPath assertions, state hashes, transcript rules, optional LLM judges.
- Rich Metrics – pass@k, cost/token estimates, latency percentiles, failure attribution.
- Interactive Terminal – Optional Rich Live panel with trial list, live counters, budgets, and on-demand Docker container log inspection; panel-modal keyboard nav (
Tab/j/k/l). See docs/CLI.md § Keyboard navigation. - Distributed Runner – SQLite for local runs, Postgres for multi-machine execution.
- Bring-Your-Own Models – Any provider supported by LiteLLM (OpenAI, Anthropic, Google, Azure, Bedrock, Ollama, OpenRouter, and more).
Installation
pip install tolokaforge # library only (headless / server)
pip install "tolokaforge[dx]" # + terminal CLI (Rich panels, banners)
pip install "tolokaforge[browser]" # + Playwright
pip install "tolokaforge[all]" # everything
The [dx] extras install the terminal front-end that owns the tolokaforge CLI — Rich panels, banners, and the Click command tree. Without them the library still imports (from tolokaforge.core.orchestrator import Orchestrator), and the tolokaforge console script prints an install hint pointing at pip install 'tolokaforge[dx]'. Front-end pluggability is recorded in ADR-0019.
Dev install:
curl -LsSf https://astral.sh/uv/install.sh | sh
uv sync
uv tool install --editable '.[dx]' --python 3.12 # exposes `tolokaforge` on PATH
The last line installs the tolokaforge command globally (into ~/.local/bin/). --editable keeps it pointing at your working tree so git pull updates it. All examples below assume tolokaforge is on PATH; if you skip the install step, prefix every command with uv run (e.g. uv run tolokaforge run …).
GitHub Codespaces
Open the repo in a Codespace (Code → Codespaces → Create codespace) for a
ready-to-run environment. The container image ships a pinned uv, git-lfs,
Node, the gh CLI, and Playwright's OS dependencies. On create and attach it
runs uv sync, installs Playwright's Chromium, pulls Git LFS objects, and
installs the pre-commit hooks. To run evaluations, supply a provider key as a
Codespaces secret
or in .env — tolokaforge run reads it from the environment.
See Python Package Guide for all extras and programmatic API usage.
To run a single trial in-process from Python, tolokaforge.runner.run_trial(...) returns a typed TrialResult — see docs/API.md and the runnable examples/library/run_trial.py.
To drive a trial from any language over a pipe, tolokaforge run-trial runs one trial as a subprocess speaking a JSON-Lines wire — see docs/API.md and the runnable examples/run-trial/drive_run_trial.py.
Prebuilt images are published to Docker Hub as docker.io/tolokasoft1/tolokaforge-{runner,db-service,rag-service,mock-web} under a coordinated semver tag axis (:X.Y.Z, :X.Y, :latest, :X.Y.Z-rc.N), so a host with only Docker installed can docker pull them instead of building from a checkout — see the Standalone Runner Guide.
Quick Start
# 1. Configure provider keys
cp .env.example .env
# 2. Run one of the included examples
tolokaforge run --config examples/native/coding/run_configs/dev.yaml
# 3. Check results
tolokaforge status --run-dir results/coding_example
tolokaforge analyze --trajectory results/coding_example/trials/<task_id>/0/trajectory.yaml
Running tolokaforge with no subcommand drops into an interactive shell with tab-completion of every subcommand and flag — see docs/CLI.md § Interactive shell.
Under --display=rich (the default on a TTY), tolokaforge run opens a live panel with a trial list, focused-trial summary, budgets, and a components monitor. Tab cycles between panels (Trials / Engine Components / per-trial Infrastructure); j / k walk rows within the active panel; l on any focused row reveals its live Docker stdout / stderr. Full cheatsheet in docs/CLI.md § Keyboard navigation. All non-rich modes (--display=plain|log|none) work unchanged and keep the classic tolokaforge status / tolokaforge analyze / tolokaforge browse subcommands available.
That's it. Docker services for browser / mobile / RAG tasks start automatically via
auto_start_services (default: true).
What is a run config?
A run config (e.g. examples/native/coding/run_configs/dev.yaml) is a single YAML file
that fully specifies an evaluation. The harness reads it and runs the benchmark:
models: # which LLM(s) drive the agent + user simulator
agent: {provider: openrouter, name: anthropic/claude-sonnet-4-6, ...}
user: {provider: openrouter, name: anthropic/claude-sonnet-4-6, ...}
orchestrator: # how the run is executed
workers: 4 # parallel trials
repeats: 1 # trials per task
max_turns: 20
evaluation: # what to evaluate
tasks_glob: "**/task.yaml" # which tasks to load (relative to task_packs root or repo)
task_packs: # optional: directories that contain task.yaml files
- "examples/native/coding/dataset"
output_dir: "results/coding_example"
To write your own benchmark, copy a working example as a starting point:
cp examples/native/coding/run_configs/dev.yaml my_run.yaml
$EDITOR my_run.yaml # change model, tasks_glob, output_dir
tolokaforge run --config my_run.yaml
Every example under examples/ ships a run_config.yaml next to its
task data. There is no global "default" config — the run config and the tasks it
points at always travel together.
For distributed execution and advanced workflows see the Runner Guide.
Runtime modes
Every trial runs inside a Docker stack. Two runtime backends decide how that stack is scoped:
shared(default): one stack materialises at run start and every trial hits it. Fast startup, lowest overhead.per_trial: a fresh stack materialises for each trial via Testcontainers. Strict isolation — DB rows, filesystem edits, service state never leak across trials. Use it whenever a task mutates its environment.
Pick per-run via the CLI flag or the config key:
tolokaforge run --config my_run.yaml --runtime per_trial
# my_run.yaml
orchestrator:
runtime: per_trial # or "shared" (default)
A task can also declare its requirement via environment_manifest.isolation
in task.yaml — the orchestrator refuses to run a per_trial task on the
shared backend so cross-trial contamination is a startup-time error, not a
silent grading bug.
Read docs/isolated_trials.md for a walkthrough (when to use each mode, how to opt in, cost tradeoffs), or docs/RUNTIME_BACKENDS.md for the full lifecycle deep-dive.
Multi-container tasks
Tasks aren't limited to the engine's built-in stack (runner + db-service ±
RAG ± mock-web). A task can declare its own docker-compose.yaml — the
task pack ships the compose file next to task.yaml, and the engine
materialises that stack instead. Real databases, real APIs, custom
services, whatever the compose file names.
# project.yaml
default_environment:
stack:
compose_file: "./environment.compose.yaml"
runner_service: "runner"
services:
app-db: # per-service isolation: shared | reset | ephemeral
isolation: "reset"
reset: { seed: "postgres_baseline" }
network_policy: "no_internet"
The multi_service example is the
smallest working demonstration (runner + db-service + an nginx serving a
product catalog); its two siblings scale up to a multi-endpoint join and a
full PostgREST + postgres three-tier stack.
Start with the Multi-Container Guide — how the multi-container runtime works, how to run the six example packs, how to author your own stack, and how substrate grading works. For the case-matrix that decides which mode fits your task, see ADR-0018.
Project Structure
tolokaforge/ # Installable Python package
├── cli/ # CLI commands (run, validate, status, analyze)
├── core/ # Orchestration, grading, metrics, queue
├── tools/ # Built-in + MCP tool system
└── env/ # Environment services (JSON DB, mock web, RAG)
examples/ # Reference task layouts with runnable run_config.yaml
├── native/ # default `native` adapter
│ ├── browser_task/
│ ├── coding/
│ ├── multi_service/ # task-declared compose (nginx catalog)
│ ├── multi_service_advanced/ # multi-endpoint join
│ ├── multi_service_postgres/ # PostgREST + postgres three-tier
│ ├── multi_service_postgres_reset/ # project layer + per-trial postgres reset
│ ├── multi_service_slow_start/ # startup-order stress (slow-start postgres)
│ ├── example-microservices-pack/ # reference project for the Project schema
│ ├── native_shared_domain/
│ └── tool_use/
└── terminal_bench/ # `terminal_bench` adapter (Docker compose)
Documentation
| Topic | Link |
|---|---|
| Getting started | docs/GETTING_STARTED.md |
| Architecture overview | docs/ARCHITECTURE.md |
| Task authoring | docs/TASKS.md |
| Grading system | docs/GRADING.md |
| Tool reference | docs/TOOLS.md |
| Browser/mobile tools | docs/BROWSER_TOOLS.md |
| Runner & distributed execution | docs/RUNNER.md |
Standalone runner (embed / docker pull) |
docs/STANDALONE_RUNNER.md |
| Runtime backends (shared vs per-trial) | docs/RUNTIME_BACKENDS.md |
| Projects — top-level abstraction | docs/PROJECTS.md |
| Reset recipes (seed-backed per-trial reset) | docs/RESET_RECIPES.md |
| Isolated trials guide | docs/isolated_trials.md |
| Multi-container task guide | docs/MULTI_CONTAINER_GUIDE.md |
| Adapter architecture | docs/ADAPTER_ARCHITECTURE.md |
| Analytics & failure attribution | docs/ANALYTICS.md |
| Python package API | docs/PYTHON_PACKAGE.md |
| Task packs | docs/TASK_PACKS.md |
| Configuration reference | docs/REFERENCE.md |
| Security model | docs/SECURITY.md |
| Docker runtime | docs/BENCHMARK_BACKEND_DESIGNS.md |
| Benchmark types | docs/BENCHMARK_TYPES.md |
| Releasing (PyPI + Docker images) | docs/RELEASING.md |
| Testing guide | tests/README.md |
Examples
Single-container tasks — one runner container plus the engine's built-in services (db-service, mock-web, RAG on demand):
| Example | Description |
|---|---|
examples/native/coding/ |
Simplest native pattern — file-write grading |
examples/native/tool_use/ |
Structured tool-call grading |
examples/native/browser_task/ |
Browser tool against mock-web fixtures |
examples/native/native_shared_domain/ |
_shared/domain.yaml + FastMCP pattern |
examples/terminal_bench/ |
Docker-compose stacks with terminal_bench adapter |
Multi-container tasks — the task ships its own compose file declaring additional services (see MULTI_CONTAINER_GUIDE.md):
| Example | Description |
|---|---|
examples/native/multi_service/ |
Smallest multi-service task — runner + db-service + nginx product catalog |
examples/native/multi_service_advanced/ |
Multi-endpoint aggregation across two task-specific HTTP APIs |
examples/native/multi_service_postgres/ |
Realistic three-tier stack — PostgREST + postgres, no application code in the task pack |
examples/native/multi_service_postgres_reset/ |
Project layer — per-trial postgres reset via a named sql_dump seed |
examples/native/multi_service_slow_start/ |
Cross-service startup-order stress — slow-start postgres + depends_on: service_healthy |
examples/native/example-microservices-pack/ |
Reference project for the full Project schema (see docs/PROJECTS.md) |
Testing
make test # all tests
make test-unit # fast, isolated
make test-functional # mocked externals
See tests/README.md for integration/E2E tests and contribution guidelines.
License
Apache-2.0 — see LICENSE.
Contributing
See CONTRIBUTING.md.
Citation
Use CITATION.cff or CITATION.bib when referencing Tolokaforge in papers or reports.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tolokaforge-0.13.0.tar.gz.
File metadata
- Download URL: tolokaforge-0.13.0.tar.gz
- Upload date:
- Size: 2.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e2e0e46ba44884c48817fe7299af9a6275a074b4e0e24612b36a1392bda701c3
|
|
| MD5 |
3fbfe67a462c87f28580bb71af2ac2eb
|
|
| BLAKE2b-256 |
3a9a36ff898674aad6c08950251e1168c35d5fc7cf377050df91e9d24f9234e9
|
File details
Details for the file tolokaforge-0.13.0-py3-none-any.whl.
File metadata
- Download URL: tolokaforge-0.13.0-py3-none-any.whl
- Upload date:
- Size: 826.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f1c59bd756e3939ce04c2695827cd8cabe9b2007b0e4b1ea9f9aad42a47dce4a
|
|
| MD5 |
44bdfe78ccf52ef82ca36db8d48e9637
|
|
| BLAKE2b-256 |
c4a45c75e174b71c7783f84274cfff681ce3454c5110c991d7f05a4aa9417651
|