> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Framework Adapter Protocol • AI Agent SDK

> FrameworkAdapterProtocol: Contract for YAML-driven multi-framework execution backends.

# FrameworkAdapterProtocol

> Defined in the [**protocols**](https://praison.ai/docs/sdk/reference/praisonaiagents/modules/protocols.md) module.

AI Agent

Contract for YAML-driven multi-framework execution backends.

## Properties

**name** `str`

No description available.

**install\_hint** `str`

No description available.

**requires\_tools\_extra** `bool`

No description available.

**is\_router** `bool`

No description available.

## Methods

> [card] [is\_available()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/FrameworkAdapterProtocol-is_available.md)
>
> Return True when this framework's optional dependencies are installed.

> [card] [resolve()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/FrameworkAdapterProtocol-resolve.md)
>
> Pick a concrete adapter variant (e.g. autogen v0.2 vs v0.4).

> [card] [setup()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/FrameworkAdapterProtocol-setup.md)
>
> Framework-specific pre-run hooks (observability, SDK init, etc.).

> [card] [run()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/FrameworkAdapterProtocol-run.md)
>
> Execute the framework with shared agents.yaml configuration.

> [card] [arun()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/FrameworkAdapterProtocol-arun.md)
>
> Async execution; default implementations may offload sync run().

> [card] [cleanup()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/FrameworkAdapterProtocol-cleanup.md)
>
> Release resources after execution.

> [card] [resolve\_alias()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/FrameworkAdapterProtocol-resolve_alias.md)
>
> Return the concrete adapter name to dispatch to.

## Source

> [card] [View on GitHub](https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/frameworks/protocols.py#L9)
>
> `praisonaiagents/frameworks/protocols.py` at line 9


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.