Skip to main content

phi_agent/
lib.rs

1//! phi-agent: General-purpose AI Agent framework
2//!
3//! Built on agent-base and agent-works, providing builder factory, renderer,
4//! config resolution, session management, and other infrastructure.
5//! **Does not bundle any tools** — tools are injected by consumers.
6
7#![warn(missing_docs)]
8
9pub mod agent;
10pub mod bridge;
11pub mod cli;
12pub mod config;
13pub mod event_log;
14/// System prompt generation (EN/CN).
15pub mod prompt;
16pub mod render;
17/// Session management — ID resolution, locking, snapshots, cleanup.
18pub mod session;
19
20// ── Common agent-base types ──
21// Only re-export the types consumers use most often.
22// For the full type set, import directly from agent-base.
23//
24// Note: AgentBuilder re-exports agent_works::AgentBuilder (not agent_base::AgentBuilder)
25// because phi-agent is a full-stack framework that includes multi-agent, skills, MCP, etc.
26// For the bare runtime builder, use agent_base::AgentBuilder directly.
27pub use agent_base::{
28    AgentError, AgentResult, AgentRuntime, ApprovalHandler, ApprovalRequest, ConsecutiveFailureRecovery, LlmClient,
29    Middleware, OpenAiClient, PlanItem, PlanStepStatus, PostLlmCtx, PreLlmCtx, ReasoningConfig, ReasoningEffort,
30    RunOutcome, RuntimeEvent, SafetyConfig, SessionId, Tool, ToolContext, ToolControlFlow, ToolMetadata, ToolOutput,
31    ToolPolicy, TurnFactMiddleware, TurnToolLimitMiddleware, UpdatePlanTool, UserMessageCtx,
32};
33pub use agent_works::AgentBuilder;
34
35// ── phi-telemetry (metrics types and storage) ──
36#[cfg(feature = "telemetry")]
37pub use phi_telemetry::{
38    SessionMetrics, SessionOutcome, SessionSummary, TurnMetrics, TurnOutcome, list_all_metrics, load_metrics,
39    save_metrics, try_load_metrics,
40};
41
42// ── agent-works ──
43pub use agent_works::focus::{Context as FocusContext, Focus, FocusError, FocusInput, FocusOutput};
44
45// ── MCP (feature-gated) ──
46#[cfg(feature = "mcp")]
47pub use agent_works::mcp::{McpServeConfig, McpServer, McpServerConfig, McpServerTransport, McpTransport};
48
49// ── phi-agent types ──
50pub use agent::{CompressionConfig, PhiAgent, PhiAgentConfig, SummarizingMiddleware, base_agent_builder};
51pub use cli::{ApprovalMode, AutoApprovalHandler};
52pub use config::{LlmConfig, resolve_llm_config};
53pub use event_log::{event_to_jsonl, event_to_value, save_turn_log};
54pub use prompt::{build_system_prompt, build_system_prompt_cn};
55pub use render::{
56    EventRenderer, JsonStreamRenderer, NullRenderer, OutputFormat, create_renderer, create_stdout_renderer,
57};
58pub use session::{
59    SessionContext, SnapshotInfo, cleanup_expired_sessions, create_snapshot, delete_snapshot, list_snapshots,
60    resolve_session, restore_snapshot, validate_session_id, validate_snapshot_name,
61};