Installation
Quick Start
use ;
async
Use Cases
Here you find example applications built with this project.
Consider configuring your LLM provider (see Environment).
Project Scanner
A scanner project for scanning and analyzing local files.
Output:
Deep Research
A simple deep research application. Requires BRAVE_API_KEY for web search.
Output:
{
"title": "What Constitutes a Good Life: A Multi-Perspective Analysis",
"research": "A good life emerges from the convergence of philosophical wisdom, scientific research, and cultural understanding. Key elements include meaningful relationships and social connections, a sense of purpose and personal growth, physical and mental well-being, contributing to something beyond oneself, and living in accordance with personal values. While cultural contexts vary, common themes across traditions emphasize virtue, balance, gratitude, and the cultivation of both inner fulfillment and positive impact on others."
}
Model Pricing Tracker
A model price checker.
Output:
API
This crate provides a core implementation of agentic behavior: execution loop, built-in tools, agent orchestration, multi-provider support, schema-based output, and retry mechanisms.
Supported Providers
You can integrate your agentic application with the following providers:
use ;
let provider = new;
let provider = new;
let provider = new;
let provider = new;
Agent
The main interface for launching an agent:
use Agent;
let output = new
.identity_prompt
.instruction_prompt
.model
.tool
.provider
.run
.await?;
Prompting
Prompts are the core piece of every agentic application.
| Method | File variant | Purpose |
|---|---|---|
identity_prompt |
identity_prompt_file |
Persistent identity of the agent |
instruction_prompt |
instruction_prompt_file |
Task for the current run |
context_prompt |
context_prompt_file |
Additional context appended after environment metadata (working directory, platform, OS version, date) |
behavior_prompt |
behavior_prompt_file |
Override the default behavioral directives (DEFAULT_BEHAVIOR_PROMPT) |
new
.identity_prompt_file
.instruction_prompt
.behavior_prompt_file
Use {key} placeholders in the identity prompt and fill them with template_variable:
new
.identity_prompt
.template_variable
.template_variable
Sub-agents
Sub-agents allow orchestrator agents to launch her own workers.
Orchestrator agents automatically have access to the SpawnAgentTool.
let researcher_base = new
.model
.identity_prompt
.tool
.max_turns;
let r1 = researcher_base.clone.name;
let r2 = researcher_base.clone.name;
let output = new
.name
.identity_prompt
.sub_agents
Inheritance
The following fields are inherited, shared or owned by the sub-agents:
| Behavior | Fields |
|---|---|
| Inherited | provider, model, working_directory, event_handler, cancel_signal |
| Shared | command_queue, session_store |
| Per sub-agent | identity_prompt, behavior_prompt, context_prompt, tools, output_schema, max_turns, max_tokens, max_schema_retries, max_request_retries, request_retry_backoff_ms |
| Per sub-agent invocation | instruction_prompt |
Guardrails
For protecting your budget or data, you can define clear execution rules for typical LLM failures:
| Method | Default | What it does |
|---|---|---|
.max_turns(10) |
no limit | Stop after N agentic loop iterations |
.max_tokens(4096) |
provider default | Cap output tokens per LLM request |
.max_schema_retries(3) |
10 | Retry structured output compliance |
.max_request_retries(5) |
3 | Retry on transient API errors (429, 529, 5xx) |
.request_retry_backoff_ms(2000) |
10,000 | Base delay for exponential backoff (ms * 2^attempt) |
To abort from outside the agent, use .cancel_signal(signal) — see
Inheritance for how it propagates across sub-agents.
AgentPool
Orchestrate complex workflows in parallel. Use different execution strategies:
CompletionOrder: results are returned as each agent finishes (default).SpawnOrder: results are returned in the order agents were spawned.
use ;
let template = new
.model
.tool;
let pool = new
.batch_size
.ordering;
for doc in
let results = pool.drain.await; // Vec<(JobId, Result<AgentOutput>)>
spawn() can be called after the pool has started processing. If the pool
is at capacity, it waits for a free slot.
Events
You can inspect what your agent is doing and how the LLM provider API is used:
use ;
let handler = new;
| Kind | Description | |
|---|---|---|
| Agent | AgentStart |
Agent begins execution |
AgentEnd |
Agent finishes execution | |
TurnStart / TurnEnd |
Turn boundaries | |
| LLM Provider | RequestStart / RequestEnd |
LLM request lifecycle |
ResponseTextChunk |
Streamed text token arrived | |
TokenUsage |
Token counts for a request changed | |
| Tool Usage | ToolCallStart / ToolCallEnd |
Tool execution lifecycle |
Tools
Give your agent access to simple tools for driving tasks:
use ;
let tool = new
.schema
.read_only
.handler
.build;
Use
.read_only(true)when a tool has no side effects. If set, the the execution loop will run tools in parallel.
Built-in tools:
| Tool | Description | |
|---|---|---|
| File | ReadFileTool |
Read a file with line numbers, offset, and limit |
WriteFileTool |
Create or overwrite a file | |
EditFileTool |
Find-and-replace in a file | |
| Search | GlobTool |
Find files by pattern (e.g., **/*.rs) |
GrepTool |
Search file contents by substring | |
ListDirectoryTool |
List directory entries with type and size | |
| Shell | BashTool::unrestricted() |
Execute any shell command |
BashTool::new(name, pattern) |
Execute shell commands matching a glob pattern | |
| Web | WebFetchTool |
Fetch a URL and return its content as text |
| Utility | SpawnAgentTool |
Delegate work to a sub-agent |
TaskTool |
Persistent task management (create, update, list, get) | |
ToolSearchTool |
Discover available tools by keyword |
use ;
let agent = new
.tool
.tool
.tool
.run.await?;
AgentOutput
The result of running an agent.
output.response_raw // Raw LLM output
output.response // validated with schema
output.statistics.input_tokens // total input tokens
output.statistics.output_tokens// total output tokens
output.statistics.requests // number of LLM requests
output.statistics.tool_calls // number of tool calls
output.statistics.turns // number of loop turns
With an output schema, the agent returns validated JSON:
let output = new
.output_schema
.max_schema_retries // retry if agent doesn't comply (default: 3)
.run.await?;
output.response.unwrap // "billing"
Or load the schema from a file:
let output = new
.output_schema_file
.run.await?;
LLM Request Composition
Each LLM request is assembled from the following parts:
| Part | Type | Parameters | Description |
|---|---|---|---|
| model | String |
model() |
The LLM model that processes the request |
| max_tokens | Number |
max_tokens() |
The maximum number of tokens the model can output |
| tool_choice | ToolChoice |
output_schema() |
A constraint that forces the model to call a specific tool |
| system_prompt | String |
identity_prompt()behavior_prompt() |
Persistent instructions that define who the agent is and how it behaves |
| message | Message[] |
context_prompt()instruction_prompt() |
The conversation history between user and assistant, starting with metadata, context, and the task |
| tools | ToolDefinition[] |
tool() |
The functions the model can call during execution |
Development
Building and testing
Integration tests
Consider configuring your LLM provider (see Environment).
Use cases
Publishing
LiteLLM proxy
Start a local LiteLLM proxy on port 4000 that forwards to a provider. Requires Docker.
Environment
Use cases and integration tests use the following environment variables:
| Variable | Description |
|---|---|
LITELLM_PROVIDER |
Explicit provider selection (anthropic, mistral, openai, litellm). Skips auto-detection |
Anthropic
| Variable | Description |
|---|---|
ANTHROPIC_API_KEY |
API key (required) |
ANTHROPIC_BASE_URL |
API URL (default: https://api.anthropic.com) |
ANTHROPIC_MODEL |
Model (default: claude-sonnet-4-20250514) |
Mistral
| Variable | Description |
|---|---|
MISTRAL_API_KEY |
API key (required) |
MISTRAL_BASE_URL |
API URL (default: https://api.mistral.ai) |
MISTRAL_MODEL |
Model (default: mistral-medium-2508) |
OpenAI
| Variable | Description |
|---|---|
OPENAI_API_KEY |
API key (required) |
OPENAI_BASE_URL |
API URL (default: https://api.openai.com) |
OPENAI_MODEL |
Model (default: gpt-4o) |
LiteLLM proxy
| Variable | Description |
|---|---|
LITELLM_BASE_URL |
Proxy URL (default: http://localhost:4000) |
LITELLM_API_KEY |
Auth key (optional) |
LITELLM_MODEL |
Model (default: claude-sonnet-4-20250514) |
LITELLM_PROVIDER |
LLM provider (default: anthropic, options: anthropic, mistral, openai) |