HAL9000
7ae95ad229
CI / push-validation (pull_request) Successful in 52s
CI / helm (pull_request) Successful in 1m25s
CI / build (pull_request) Successful in 8m2s
CI / lint (pull_request) Successful in 8m46s
CI / security (pull_request) Successful in 9m18s
CI / quality (pull_request) Successful in 9m25s
CI / integration_tests (pull_request) Failing after 9m44s
CI / typecheck (pull_request) Successful in 10m1s
CI / e2e_tests (pull_request) Successful in 13m54s
CI / unit_tests (pull_request) Failing after 16m23s
CI / docker (pull_request) Has been skipped
CI / coverage (pull_request) Successful in 11m26s
27 lines
1.8 KiB
Markdown
27 lines
1.8 KiB
Markdown
# 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.shared`](shared.md) | Secret redaction utilities for logs, telemetry, and structured errors |
|
|
| [`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.lsp`](lsp.md) | Language Server Protocol integration — registry, runtime, client, and tool adapter |
|
|
| [`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.
|