Files
freemo e9c96c3d0c
CI / build (push) Successful in 17s
CI / lint (push) Failing after 19s
CI / helm (push) Successful in 34s
CI / security (push) Failing after 42s
CI / quality (push) Has been cancelled
CI / unit_tests (push) Has been cancelled
CI / e2e_tests (push) Has been cancelled
CI / integration_tests (push) Has been cancelled
CI / typecheck (push) Has been cancelled
CI / benchmark-publish (push) Has been cancelled
CI / coverage (push) Has been cancelled
CI / benchmark-regression (push) Has been cancelled
CI / docker (push) Has been cancelled
CI / status-check (push) Has been cancelled
docs: add API reference and architecture overview
Add docs/api/ with per-module API documentation for core, a2a, actor,
skills, tool, mcp, resource, and config packages. Add docs/architecture.md
with a developer-oriented system overview including component map, layer
diagram, plan lifecycle, and key design decisions. Update mkdocs.yml nav
to expose both new sections.

ISSUES CLOSED: #N/A
2026-04-02 19:02:53 +00:00

1.3 KiB

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.a2a Agent-to-Agent (A2A) protocol facade, transport, models, and events
cleveragents.actor Actor registry, configuration, loader, and compiler
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.resource Resource schema, handlers, and type-inheritance system
cleveragents.config Application settings, logging, metrics, and security scanning

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