API Overview

On this page

Core orchestration
Base
Errors
Metadata
Plugin types
Security
AI integration
Not in __all__ but part of the public surface
Search by task

This is the complete public API surface exported from plugins/__init__'s __all__ list, grouped by subsystem. Every symbol below links to its dedicated reference page.

Core orchestration

Symbol	Kind	Module	Description
`PluginManager`	class	`plugin_manager`	Top-level façade: lifecycle, execution, hooks, dashboard
`PluginRegistry`	class	`registry`	In-memory catalog with search and LLM tool-descriptor export
`PluginLoader`	class	`loader`	Filesystem discovery, dynamic import, lazy loading, hot-reload tracking

Base

Symbol	Kind	Module	Description
`BasePlugin`	abstract class	`base_plugin`	Contract every plugin implements
`PluginConfig`	class	`base_plugin`	Per-instance runtime knobs (timeout, retries, caching)

Errors

Symbol	Kind	Module	Description
`PluginError`	exception	`base_plugin`	Base exception for all plugin errors
`PluginTimeoutError`	exception	`base_plugin`	Raised when execution exceeds `config.timeout`
`PluginValidationError`	exception	`base_plugin`	Raised on input schema validation failure
`PluginPermissionError`	exception	`base_plugin`	Raised on forbidden operations / failed pre-flight checks

Metadata

Symbol	Kind	Module	Description
`PluginMetadata`	dataclass	`metadata`	Full AI-queryable plugin metadata
`SchemaProperty`	dataclass	`metadata`	One field in an input/output JSON schema
`ExecutionContext`	dataclass	`metadata`	Runtime context passed to every `execute()` call
`PluginStatus`	enum	`metadata`	Lifecycle state
`PluginPriority`	enum	`metadata`	Priority weighting (`CRITICAL`=1000 … `BACKGROUND`=1)
`PermissionType`	enum	`metadata`	The 8 declared permission kinds
`CostTier`	enum	`metadata`	`free` / `cheap` / `moderate` / `expensive`

Plugin types

Symbol	Kind	Module	Description
`RetrievalPlugin`	abstract class	`types.retrieval_plugin`	Search / fetch documents
`ToolPlugin`	abstract class	`types.tool_plugin`	Call external tools/APIs
`ActionPlugin`	abstract class	`types.action_plugin`	Perform mutating side-effects
`ProcessingPlugin`	abstract class	`types.processing_plugin`	Transform/rerank/summarize data
`PLUGIN_TYPE_MAP`	dict constant	`types`	`str → type` map of the four types above

Security

Symbol	Kind	Module	Description
`PermissionGuard`	class	`security`	Grant/revoke/check per-plugin permissions
`InputSanitizer`	class	`security`	Schema validation + injection-pattern detection
`ExecutionSandbox`	class	`security`	Timeout-wrapped coroutine execution

AI integration

Symbol	Kind	Module	Description
`AIPluginSelector`	class	`plugin_manager`	Keyword + optional semantic plugin selection
`PluginObservability`	class	`plugin_manager`	In-process execution metrics store

Not in `all` but part of the public surface

Symbol	Kind	Module	Description
`PluginHotReloader`	class	`hot_reload`	Background watcher; imported into `plugins/__init__.py` inside a `try/except ImportError` and therefore not listed in `__all__`, but available as `plugins.PluginHotReloader` when import succeeds

Search by task

"I want to build a plugin" → BasePlugin, plugin types
"I want to find the right plugin for a user query" → AIPluginSelector, PluginRegistry.search
"I want to expose plugins to an LLM" → PluginMetadata.to_tool_descriptor, PluginRegistry.to_tool_descriptors
"I want to lock down what a plugin can do" → PermissionGuard
"I want plugins to reload without restarting my process" → PluginHotReloader, PluginLoader.reload_file

API Overview

Core orchestration

Base

Errors

Metadata

Plugin types

Security

AI integration

Not in __all__ but part of the public surface

Search by task

Related pages

Not in `all` but part of the public surface