yoagent 0.14.2

Simple, effective agent loop with tool execution and event streaming
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

// Enables the `doc_cfg` feature badges on docs.rs only; a no-op on stable.
#![cfg_attr(docsrs, feature(doc_cfg))]

//! **yoagent** — the agent runtime for Rust.
//!
//! A simple, effective agent loop with tool execution and event streaming:
//! `Prompt → LLM stream → tool execution → loop`. The loop is the product;
//! everything else is optional layers on top of it.
//!
//! # Quick start
//!
//! ```no_run
//! use yoagent::{Agent, provider::ModelConfig, tools};
//!
//! # #[tokio::main]
//! # async fn main() {
//! // Provider is selected from the config's protocol; the API key is read
//! // from ANTHROPIC_API_KEY. Call `.with_api_key(...)` to override.
//! let mut agent = Agent::from_config(ModelConfig::anthropic("claude-sonnet-5", "Sonnet 5"))
//!     .with_system_prompt("You are a helpful coding assistant.")
//!     .with_tools(tools::default_tools());
//!
//! let mut events = agent.prompt("List the files in the current directory").await;
//! while let Some(event) = events.recv().await {
//!     // stream text deltas, tool calls, usage — render however you like
//! }
//! agent.finish().await;
//! # }
//! ```
//!
//! # What's in the box
//!
//! - **The loop** ([`agent_loop()`](agent_loop())) — a stateless free function; [`Agent`] is an
//!   optional stateful wrapper (history, tool registry, steering queues).
//! - **7 provider protocols, 20+ providers** ([`provider`]) — Anthropic,
//!   OpenAI (Completions + Responses), Azure, Gemini, Vertex, Bedrock, plus
//!   OpenAI-compatible gateways (Groq, DeepSeek, xAI, OpenCode, Ollama, ...)
//!   with per-provider quirk flags.
//! - **Tools** ([`tools`]) — bash, read/write/edit file, search; add your own
//!   via the [`AgentTool`] trait. [MCP](mcp) servers and
//!   [OpenAPI specs](https://docs.rs/yoagent/latest/yoagent/openapi/index.html)
//!   (feature `openapi`) become tools transparently.
//! - **Steering** — inject guidance into a running agent ([`Agent::steer`]);
//!   picked up between tool executions (per batch under the default parallel
//!   strategy). Queue follow-ups, inspect/edit the queues.
//! - **Structured outputs** ([`Agent::prompt_structured`]) — typed,
//!   schema-validated replies, enforced natively where supported (forced
//!   tool call / `json_schema` / `responseSchema`).
//! - **Permissions** ([`ToolMiddleware`]) — async approve/deny/modify hooks
//!   gating every tool call; the mechanism behind approval prompts and
//!   policy engines (yoagent ships no policy — you install it).
//! - **Input filtering** ([`InputFilter`]) — rewrite or reject user input
//!   before it reaches the model (PII redaction, prompt-injection guards).
//! - **Sub-agents** ([`SubAgentTool`]) — delegation with per-sub-agent models
//!   and [`SharedState`] for passing artifacts by reference.
//! - **GASP** (feature `gasp`) — record runs into a
//!   [GASP](https://github.com/yologdev/gasp) agent repo: append-only
//!   semantic event log, restore = clone + replay, conformance-checked in CI.
//! - **Session trees** ([`Session`]) — branching conversation history with
//!   fork, checkpoints, and JSONL persistence; edit an earlier turn and
//!   re-run without losing the original branch.
//! - **Context management** ([`context`]) — token tracking and tiered
//!   compaction so long sessions keep running.
//! - **Skills** ([`skills`]) — load `SKILL.md` files per the
//!   [AgentSkills](https://agentskills.io) standard.
//! - **Telemetry** — `tracing` spans per loop/LLM-stream/tool with token and
//!   cost fields; bridge to OpenTelemetry app-side, negligible cost otherwise.
//! - **Testing** ([`provider::mock::MockProvider`]) — script a whole multi-turn
//!   tool-calling conversation with no network. It honours the cancellation
//!   token, so abort and steering paths are testable too.
//!
//! The [book](https://yologdev.github.io/yoagent/) covers concepts and
//! provider-specific guides.

pub mod agent;
pub mod agent_loop;
pub mod context;
pub mod mcp;
pub mod provider;
pub mod retry;
pub mod session;
pub mod shared_state;
pub mod skills;
pub mod sub_agent;
pub mod tools;
pub mod types;

#[cfg(feature = "openapi")]
#[cfg_attr(docsrs, doc(cfg(feature = "openapi")))]
pub mod openapi;

#[cfg(feature = "gasp")]
#[cfg_attr(docsrs, doc(cfg(feature = "gasp")))]
pub mod gasp;

pub use agent::{Agent, AgentBuildError, StructuredPromptError};
pub use agent_loop::{agent_loop, agent_loop_continue};
pub use context::{CompactionStrategy, DefaultCompaction};
pub use retry::RetryConfig;
pub use session::{Session, SessionEntry, SessionError};
pub use shared_state::SharedState;
pub use skills::SkillSet;
pub use sub_agent::SubAgentTool;
pub use types::*;