phi_agent/
lib.rs

1//! phi-agent: Rust AI Agent runtime framework — orchestration, sessions, streaming all built-in.
2//! You only define tools, prompts, and domain knowledge.
3//!
4//! Built on agent-base and agent-works, providing builder factory, renderer,
5//! config resolution, session management, and other infrastructure.
6//! **Ships with zero application tools.** Kernel tools (file I/O, shell,
7//! multi-agent) are available via `phi-kernel-tools` behind feature flags —
8//! all off by default. Application tools are injected by consumers.
9
10#![warn(missing_docs)]
11
12pub mod agent;
13pub mod bridge;
14pub mod cli;
15pub mod config;
16pub mod event_log;
17/// System prompt generation (EN/CN).
18pub mod prompt;
19pub mod render;
20/// Session management — ID resolution, locking, snapshots, cleanup.
21pub mod session;
22
23// ── Common agent-base types ──
24// Only re-export the types consumers use most often.
25// For the full type set, import directly from agent-base.
26//
27// Note: AgentBuilder re-exports agent_works::AgentBuilder (not agent_base::AgentBuilder)
28// because phi-agent is a full-stack framework that includes multi-agent, skills, MCP, etc.
29// For the bare runtime builder, use agent_base::AgentBuilder directly.
30pub use agent_base::{
31    AgentError, AgentResult, AgentRuntime, ApprovalDecision, ApprovalHandler, ApprovalRequest,
32    ConsecutiveFailureRecovery, Content, FinishReason, LlmClient, Middleware, OpenAiClient, PlanItem, PlanStepStatus,
33    PostLlmCtx, PreLlmCtx, ReasoningConfig, ReasoningEffort, RiskLevel, RunOutcome, RuntimeEvent, SafetyConfig,
34    SessionId, Tool, ToolContext, ToolMetadata, ToolPolicy, TurnFactMiddleware, TurnToolLimitMiddleware,
35    UpdatePlanTool, UserMessageCtx,
36};
37pub use agent_works::AgentBuilder;
38
39// ── phi-telemetry (metrics types and storage) ──
40#[cfg(feature = "telemetry")]
41pub use phi_telemetry::{
42    SessionMetrics, SessionOutcome, SessionSummary, TurnMetrics, TurnOutcome, list_all_metrics, load_metrics,
43    save_metrics, try_load_metrics,
44};
45
46// ── agent-works ──
47#[cfg(feature = "focus")]
48pub use agent_works::focus::{Context as FocusContext, Focus, FocusError, FocusInput, FocusOutput};
49#[cfg(feature = "multi-agent")]
50pub use agent_works::multi_agent::{ChildPermissionMode, MultiAgentConfig};
51
52// ── MCP (feature-gated) ──
53#[cfg(feature = "mcp")]
54pub use agent_works::mcp::{McpServeConfig, McpServer, McpServerConfig, McpServerTransport, McpTransport};
55
56// ── phi-agent types ──
57#[cfg(feature = "compression")]
58pub use agent::CompressionMiddleware;
59pub use agent::{
60    PhiAgent, PhiAgentConfig, base_agent_builder, base_agent_builder_with_excludes, base_agent_builder_with_options,
61    clear_compression_cache, run_compact_session,
62};
63pub use cli::{ApprovalMode, AutoApprovalHandler};
64pub use config::{LlmConfig, resolve_llm_config};
65pub use event_log::{event_to_jsonl, event_to_value, save_turn_log};
66pub use prompt::{build_system_prompt, build_system_prompt_cn};
67pub use render::{
68    EventRenderer, JsonStreamRenderer, NullRenderer, OutputFormat, create_renderer, create_stdout_renderer,
69};
70pub use session::{
71    SessionContext, SnapshotInfo, cleanup_expired_sessions, create_snapshot, delete_snapshot, list_snapshots,
72    resolve_session, restore_snapshot, validate_session_id, validate_snapshot_name,
73};
phi_agent/lib.rs

phi_agent/
lib.rs
