llmy-agent 0.16.1

All-in-one LLM utilities.
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

//! Building blocks for tool-using LLM agents.
//!
//! `llmy-agent` provides the small, opinionated primitives that higher-level
//! crates (such as `llmy-harness`) compose into a complete agent loop:
//!
//! * [`mod@tool`] — the [`Tool`] / [`ToolDyn`] traits and the
//!   [`tool::ToolBox`] registry, used to expose Rust functions to a model and
//!   to dispatch tool calls back to them.
//! * [`agent`] — the [`StepResult`] type that summarises a single turn of an
//!   agent loop (the model either stopped with a final assistant message or
//!   issued tool calls that need to be executed before the next step).
//!
//! # Defining a tool
//!
//! Implementing [`Tool`] by hand is straightforward, but the
//! [`llmy_agent_derive::tool`] attribute macro (re-exported here as
//! [`tool`](macro@tool), and also reachable through the umbrella crate as
//! `llmy::agent::tool`) generates the boilerplate for you:
//!
//! ```ignore
//! use llmy_agent::{LLMYError, tool};
//! use schemars::JsonSchema;
//! use serde::Deserialize;
//!
//! #[derive(Deserialize, JsonSchema)]
//! struct AddArgs { a: i64, b: i64 }
//!
//! #[derive(Clone, Debug)]
//! #[tool(
//!     description = "Add two integers",
//!     arguments = AddArgs,
//!     invoke = run,
//! )]
//! struct AddTool;
//!
//! impl AddTool {
//!     async fn run(&self, args: AddArgs) -> Result<String, LLMYError> {
//!         Ok((args.a + args.b).to_string())
//!     }
//! }
//! ```
//!
//! Tools can then be collected into a [`tool::ToolBox`], rendered as OpenAI
//! tool descriptors with [`tool::ToolBox::openai_objects`], and dispatched
//! against incoming `tool_calls` with the various `invoke_*` methods.
//!
//! # Re-exports
//!
//! For convenience the most commonly used items are re-exported at the crate
//! root: [`StepResult`], [`Tool`], [`ToolDyn`], [`LLMYError`] and the
//! [`tool`](macro@tool) attribute macro.

pub mod agent;
/// MCP server support — serve a [`tool::ToolBox`] over stdio or HTTP.
pub mod mcp;
pub mod tool;

pub use agent::StepResult;
pub use llmy_agent_derive::tool;
pub use llmy_types::error::LLMYError;
pub use tool::{Tool, ToolDyn};

/// Re-export of the [`rmcp`] crate for MCP protocol types.
pub mod rcmp {
    pub use rmcp::*;
}