# 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`](core.md) | Exception hierarchy, error handling, retry patterns, async cleanup |
| [`cleveragents.a2a`](a2a.md) | Agent-to-Agent (A2A) protocol facade, transport, models, and events |
| [`cleveragents.actor`](actor.md) | Actor registry, configuration, loader, and compiler |
| [`cleveragents.skills`](skills.md) | Skill framework — schema, protocol, registry, discovery, and inline executor |
| [`cleveragents.tool`](tool.md) | Tool runtime, lifecycle, registry, router, and container executor |
| [`cleveragents.mcp`](mcp.md) | Model Context Protocol (MCP) adapter, client, registry, and sandbox |
| [`cleveragents.resource`](resource.md) | Resource schema, handlers, and type-inheritance system |
| [`cleveragents.config`](config.md) | Application settings, logging, metrics, and security scanning |
| [`cleveragents.providers`](providers.md) | AI provider registry — discovery, selection, LLM factory, and capability metadata |
| [`cleveragents.tui`](tui.md) | Interactive Terminal UI — app, persona system, input routing, slash commands, session export/import |

> **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](cli-reference.md) | Complete command reference — all command groups, flags, arguments, and environment variables |

---

## Application Services & DI

| Page | Description |
|------|-------------|
| [Python API — Application Layer](python-api.md) | Application services, DI container usage, plan lifecycle, domain models, and key protocols |

---

## Protocol Documentation

| Page | Description |
|------|-------------|
| [Protocols](protocols.md) | 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`](cli-reference.md#plan-commands) |
| Add a resource | [CLI Reference → `agents resource`](cli-reference.md#resource-commands) |
| Configure an actor | [CLI Reference → `agents actor`](cli-reference.md#actor-commands) |
| Use the Python API to create a plan | [Python API → PlanLifecycleService](python-api.md#planlifecycleservice) |
| Understand the DI container | [Python API → DI Container](python-api.md#dependency-injection-container) |
| Integrate via A2A | [Protocols → A2A](protocols.md#a2a-agent-to-agent-protocol) |
| Expose tools via MCP | [Protocols → MCP](protocols.md#mcp-model-context-protocol) |
| Attach LSP intelligence | [Protocols → LSP](protocols.md#lsp-language-server-protocol) |
| Package skills | [Protocols → AgentSkills.io](protocols.md#agentskillsio) |