forked from cleveragents/cleveragents-core

Files

T

HAL9000 df863f169b docs(api): add ACMS/UKO API reference and update nav

Add comprehensive API documentation for the cleveragents.acms package,
covering the four-layer UKO ontology hierarchy (Layer 0-3), all public
types (VocabularyRegistry, ProvenanceInfo, UKOClass, UKOProperty,
UKOVocabulary, Layer2Dependency, ParadigmVocabulary), detail level maps
(DetailLevelMapBuilder, build_detail_level_map, build_effective_map,
resolve_detail_level), and all Layer 3 language vocabulary types for
Python, TypeScript, Rust, and Java.

- Add docs/api/acms.md with full API reference and usage example
- Update docs/api/index.md to include ACMS/UKO in the module index
- Update mkdocs.yml nav to include the new ACMS/UKO page
- Update CHANGELOG.md [Unreleased] with the documentation addition

2026-04-14 15:45:11 +00:00

1.7 KiB

Raw Blame History

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
`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.

1.7 KiB Raw Blame History

API Reference

Module Index

1.7 KiB

Raw Blame History