Files
cleveragents-core/docs/api/index.md
T
HAL9000 4f2122cd9e
CI / push-validation (pull_request) Successful in 27s
CI / helm (pull_request) Successful in 32s
CI / lint (pull_request) Successful in 1m6s
CI / build (pull_request) Successful in 1m0s
CI / typecheck (pull_request) Successful in 1m35s
CI / quality (pull_request) Successful in 1m41s
CI / benchmark-publish (pull_request) Has been skipped
CI / security (pull_request) Successful in 2m50s
CI / integration_tests (pull_request) Successful in 5m3s
CI / e2e_tests (pull_request) Successful in 5m27s
CI / unit_tests (pull_request) Successful in 6m49s
CI / docker (pull_request) Successful in 1m23s
CI / coverage (pull_request) Successful in 11m17s
CI / status-check (pull_request) Successful in 3s
CI / lint (push) Successful in 1m14s
CI / security (push) Successful in 1m22s
CI / typecheck (push) Successful in 1m51s
CI / quality (push) Successful in 1m29s
CI / push-validation (push) Successful in 27s
CI / helm (push) Successful in 48s
CI / build (push) Successful in 48s
CI / integration_tests (push) Successful in 4m11s
CI / e2e_tests (push) Successful in 4m19s
CI / unit_tests (push) Successful in 6m14s
CI / docker (push) Successful in 1m33s
CI / coverage (push) Successful in 16m7s
CI / benchmark-regression (push) Has been skipped
CI / benchmark-publish (push) Failing after 1m3s
CI / status-check (push) Successful in 3s
CI / benchmark-regression (pull_request) Failing after 1h11m1s
docs: add action module API reference, update CHANGELOG and nav
- Add docs/api/action.md: full API reference for ActionConfigSchema and ActionArgumentSchema — field tables, factory methods, camelCase compat mapping, env-var interpolation, database integrity note, and complete YAML example
- Update docs/api/index.md: add cleveragents.action entry to module index
- Update mkdocs.yml: add 'Action Schema: api/action.md' to the API Reference nav
- Update CHANGELOG.md [Unreleased] Fixed: document plan use UNIQUE constraint violation fix (#4174, #4197)
- Clarify from_yaml_file ValueError semantics, document inputs_schema type as dict[str, Any] | None, and update A2A ASV benchmarks to pass method= requests after JSON-RPC migration

ISSUES CLOSED: #7472
2026-04-26 09:39:17 +00:00

1.8 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.action Action YAML configuration schema, validation, argument types, and env-var interpolation
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
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
cleveragents.acms Advanced Context Management System — UKO vocabulary registry, Layer 2/3 paradigm and language vocabularies, detail level maps

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