modular-agent-core 0.24.0

Modular Agent Core
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
105
106
107
108
109
110
111
112
113
114
115
116

#![recursion_limit = "256"]
//! # Modular Agent Core
//!
//! A Rust framework for building modular multi-agent orchestration systems.
//!
//! This crate provides tools and abstractions to create, configure, and run agents
//! in a stream-based architecture. It supports defining agent behaviors, managing
//! agent flows, and handling agent input/output through a channel-based messaging system.
//!
//! ## Core Concepts
//!
//! ### ModularAgent
//!
//! [`ModularAgent`] is the central orchestrator that manages agent lifecycle, connections,
//! and message routing. It maintains agent instances, connection maps, and handles events.
//!
//! ### Agents
//!
//! Agents are processing units that receive messages via channels and process them
//! asynchronously. Implement the [`AsAgent`] trait to create custom agents, or use the
//! `#[modular_agent]` macro for declarative agent definitions.
//!
//! ### Presets
//!
//! Presets are collections of agents and their connections, defined in JSON format.
//! They can be loaded from files and managed via [`ModularAgent`] methods.
//!
//! ## Quick Start
//!
//! See the [CLI example](https://github.com/modular-agent/modular-agent-core/blob/main/examples/cli.rs)
//! for a complete working example of loading a preset and running agents from the command line.
//!
//! ## Feature Flags
//!
//! - `file` - File handling support (enabled by default)
//! - `image` - Image processing with photon-rs (enabled by default)
//! - `llm` - LLM integration with Message/ToolCall types (enabled by default)
//! - `mcp` - Model Context Protocol integration (enabled by default)
//! - `test-utils` - Testing utilities including TestProbeAgent

mod agent;
mod config;
mod context;
mod definition;
mod error;
mod external_agent;
mod id;
mod message;
mod modular_agent;
mod output;
mod preset;
mod registry;
mod runtime;
mod spec;
mod value;

#[cfg(feature = "llm")]
pub mod llm;
#[cfg(feature = "llm")]
pub mod session;
pub mod tool;

#[cfg(feature = "mcp")]
pub mod mcp;

#[cfg(feature = "test-utils")]
pub mod test_utils;

// re-export async_trait
pub use async_trait::async_trait;

// re-export photon_rs
#[cfg(feature = "image")]
pub use photon_rs::{self, PhotonImage};

// re-export im
pub use im;

// re-export CancellationToken (used by AgentContext and ModularAgent cancellation APIs)
pub use tokio_util::sync::CancellationToken;

// re-export inventory
pub use inventory;

// re-export FnvIndexMap
pub use fnv;
pub use indexmap;
pub type FnvIndexMap<K, V> = indexmap::IndexMap<K, V, fnv::FnvBuildHasher>;
pub type FnvIndexSet<T> = indexmap::IndexSet<T, fnv::FnvBuildHasher>;

// Re-export the crate under its canonical name for proc-macros.
pub extern crate self as modular_agent_core;

// Re-exports modular_agent_macros
pub use modular_agent_macros::modular_agent;

pub use agent::{Agent, AgentData, AgentStatus, AsAgent, HasAgentData, new_agent_boxed};
pub use config::{AgentConfigs, AgentConfigsMap};
pub use context::AgentContext;
pub use definition::{AgentConfigSpec, AgentConfigSpecs, AgentDefinition, AgentDefinitions};
pub use error::AgentError;
#[cfg(feature = "llm")]
pub use llm::{
    ContentBlock, Message, MessageContent, MessageEvent, ToolCall, ToolCallFunction, Usage,
    estimate_context_tokens, estimate_message_tokens,
};
pub use modular_agent::{ModularAgent, ModularAgentEvent, SharedAgent};
pub use output::AgentOutput;
pub use preset::{Preset, PresetInfo};
pub use registry::AgentRegistration;
#[cfg(feature = "llm")]
pub use session::{
    InMemorySessionStore, JsonlSessionStore, SessionEntry, SessionMeta, SessionStore, build_context,
};
pub use spec::{AgentSpec, ConnectionSpec, PresetSpec, PresetSpecs};
pub use value::{AgentValue, AgentValueMap};