cleveragents-core/docs/api/index.md

API Reference

This section documents the public Python API of the cleveragents package. Each page covers one top-level module or sub-package, listing its exported classes, functions, and exceptions with signatures and usage examples.

Module Index

Module	Description
cleveragents.core	Exception hierarchy, error handling, retry patterns, async cleanup
cleveragents.domain	Domain base model, core domain models, value objects, and enumerations
cleveragents.a2a	Agent-to-Agent (A2A) protocol facade, transport, models, and events
cleveragents.action	Action YAML configuration schema, validation, argument types, and env-var interpolation
cleveragents.actor	Actor registry, configuration, loader, and compiler
cleveragents.domain	Domain layer — DomainBaseModel, core domain models, ACMS models, AI provider interface
cleveragents.providers	AI provider registry — discovery, capability metadata, LLM factory, and fallback selection
cleveragents.skills	Skill framework — schema, protocol, registry, discovery, and inline executor
cleveragents.tool	Tool runtime, lifecycle, registry, router, and container executor
cleveragents.mcp	Model Context Protocol (MCP) adapter, client, registry, and sandbox
cleveragents.lsp	Language Server Protocol integration — registry, runtime, tool adapter, lifecycle
cleveragents.acms	Advanced Context Management System — UKO vocabulary support, Layer 2/3 extensions
cleveragents.resource	Resource schema, handlers, and type-inheritance system
cleveragents.config	Application settings, logging, metrics, and security scanning
cleveragents.providers	AI provider registry — discovery, selection, LLM factory, and capability metadata
cleveragents.tui	Interactive Terminal UI — app, persona system, input routing, slash commands, session export/import
ACMS Services	Advanced Context Management System services — context tier hydrator, fragment indexing pipeline

Note: Internal modules (prefixed with _) and implementation details not listed in a module's __all__ are considered private and may change without notice.

---

CLI Reference

The agents / cleveragents commands expose the full platform surface from the terminal.

Page	Description
CLI Reference	Complete command reference — all command groups, flags, arguments, and environment variables

---

Application Services & DI

Page	Description
Python API — Application Layer	Application services, DI container usage, plan lifecycle, domain models, and key protocols

---

Protocol Documentation

Page	Description
Protocols	A2A (JSON-RPC 2.0), MCP, LSP, and AgentSkills.io protocol details

---

Quick Navigation

I want to…	Go to
Run a plan from the CLI	CLI Reference → agents plan
Add a resource	CLI Reference → agents resource
Configure an actor	CLI Reference → agents actor
Use the Python API to create a plan	Python API → PlanLifecycleService
Understand the DI container	Python API → DI Container
Integrate via A2A	Protocols → A2A
Expose tools via MCP	Protocols → MCP
Attach LSP intelligence	Protocols → LSP
Package skills	Protocols → AgentSkills.io